Skip to content

Commit 4602a86

Browse files
authored
docs(instance): modifs to instance doc for new developers site (#163)
1 parent 21f8b4b commit 4602a86

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

scaleway-async/scaleway_async/instance/v1/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ async def list_volumes_types(
297297
page: Optional[int] = None,
298298
) -> ListVolumesTypesResponse:
299299
"""
300-
List volumes types.
300+
List volume types.
301301
List all volume types and their technical details.
302302
:param zone: Zone to target. If none is passed will use default zone from the config.
303303
:param per_page:
@@ -814,7 +814,7 @@ async def server_action(
814814
815815
Keep in mind that terminating an Instance will result in the deletion of all attached volumes, including local and block storage.
816816
If you want to preserve your local volumes, you should use the `archive` action instead of `terminate`. Similarly, if you want to keep your block storage volumes, you must first detach them before issuing the `terminate` command.
817-
For more information, read the [Volumes](#volumes-7e8a39) documentation.
817+
For more information, read the [Volumes](#path-volumes-list-volumes) documentation.
818818
:param zone: Zone to target. If none is passed will use default zone from the config.
819819
:param server_id: UUID of the Instance.
820820
:param action: Action to perform on the Instance.
@@ -1974,7 +1974,7 @@ async def create_security_group(
19741974
:param stateful: Whether the security group is stateful or not.
19751975
:param inbound_default_policy: Default policy for inbound rules.
19761976
:param outbound_default_policy: Default policy for outbound rules.
1977-
:param enable_default_security: True to block SMTP on IPv4 and IPv6.
1977+
:param enable_default_security: True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
19781978
:return: :class:`CreateSecurityGroupResponse <CreateSecurityGroupResponse>`
19791979
19801980
Usage:
@@ -2108,7 +2108,7 @@ async def _set_security_group(
21082108
:param creation_date: Creation date of the security group (will be ignored).
21092109
:param modification_date: Modification date of the security group (will be ignored).
21102110
:param description: Description of the security group.
2111-
:param enable_default_security: True to block SMTP on IPv4 and IPv6.
2111+
:param enable_default_security: True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
21122112
:param inbound_default_policy: Default inbound policy.
21132113
:param outbound_default_policy: Default outbound policy.
21142114
:param organization: Security groups Organization ID.

scaleway-async/scaleway_async/instance/v1/types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -847,7 +847,7 @@ class SecurityGroup:
847847

848848
enable_default_security: bool
849849
"""
850-
True if SMTP is blocked on IPv4 and IPv6.
850+
True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
851851
"""
852852

853853
inbound_default_policy: SecurityGroupPolicy
@@ -2528,7 +2528,7 @@ class CreateSecurityGroupRequest:
25282528

25292529
enable_default_security: Optional[bool]
25302530
"""
2531-
True to block SMTP on IPv4 and IPv6.
2531+
True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
25322532
"""
25332533

25342534

scaleway-async/scaleway_async/instance/v1/types_private.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,7 @@ class _SetSecurityGroupRequest:
481481

482482
enable_default_security: bool
483483
"""
484-
True to block SMTP on IPv4 and IPv6.
484+
True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
485485
"""
486486

487487
inbound_default_policy: SecurityGroupPolicy

scaleway/scaleway/instance/v1/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ def list_volumes_types(
297297
page: Optional[int] = None,
298298
) -> ListVolumesTypesResponse:
299299
"""
300-
List volumes types.
300+
List volume types.
301301
List all volume types and their technical details.
302302
:param zone: Zone to target. If none is passed will use default zone from the config.
303303
:param per_page:
@@ -814,7 +814,7 @@ def server_action(
814814
815815
Keep in mind that terminating an Instance will result in the deletion of all attached volumes, including local and block storage.
816816
If you want to preserve your local volumes, you should use the `archive` action instead of `terminate`. Similarly, if you want to keep your block storage volumes, you must first detach them before issuing the `terminate` command.
817-
For more information, read the [Volumes](#volumes-7e8a39) documentation.
817+
For more information, read the [Volumes](#path-volumes-list-volumes) documentation.
818818
:param zone: Zone to target. If none is passed will use default zone from the config.
819819
:param server_id: UUID of the Instance.
820820
:param action: Action to perform on the Instance.
@@ -1974,7 +1974,7 @@ def create_security_group(
19741974
:param stateful: Whether the security group is stateful or not.
19751975
:param inbound_default_policy: Default policy for inbound rules.
19761976
:param outbound_default_policy: Default policy for outbound rules.
1977-
:param enable_default_security: True to block SMTP on IPv4 and IPv6.
1977+
:param enable_default_security: True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
19781978
:return: :class:`CreateSecurityGroupResponse <CreateSecurityGroupResponse>`
19791979
19801980
Usage:
@@ -2108,7 +2108,7 @@ def _set_security_group(
21082108
:param creation_date: Creation date of the security group (will be ignored).
21092109
:param modification_date: Modification date of the security group (will be ignored).
21102110
:param description: Description of the security group.
2111-
:param enable_default_security: True to block SMTP on IPv4 and IPv6.
2111+
:param enable_default_security: True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
21122112
:param inbound_default_policy: Default inbound policy.
21132113
:param outbound_default_policy: Default outbound policy.
21142114
:param organization: Security groups Organization ID.

scaleway/scaleway/instance/v1/types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -847,7 +847,7 @@ class SecurityGroup:
847847

848848
enable_default_security: bool
849849
"""
850-
True if SMTP is blocked on IPv4 and IPv6.
850+
True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
851851
"""
852852

853853
inbound_default_policy: SecurityGroupPolicy
@@ -2528,7 +2528,7 @@ class CreateSecurityGroupRequest:
25282528

25292529
enable_default_security: Optional[bool]
25302530
"""
2531-
True to block SMTP on IPv4 and IPv6.
2531+
True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
25322532
"""
25332533

25342534

scaleway/scaleway/instance/v1/types_private.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,7 @@ class _SetSecurityGroupRequest:
481481

482482
enable_default_security: bool
483483
"""
484-
True to block SMTP on IPv4 and IPv6.
484+
True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
485485
"""
486486

487487
inbound_default_policy: SecurityGroupPolicy

0 commit comments

Comments
 (0)