Skip to content

Commit b9a5c19

Browse files
authored
fix: update redis documentation (#367)
1 parent 64d71fc commit b9a5c19

File tree

4 files changed

+28
-6
lines changed

4 files changed

+28
-6
lines changed

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1161,9 +1161,13 @@ async def update_endpoint(
11611161
Update an endpoint.
11621162
Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
11631163
:param zone: Zone to target. If none is passed will use default zone from the config.
1164-
:param endpoint_id:
1165-
:param private_network: One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
1166-
:param public_network: One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
1164+
:param endpoint_id: UUID of the endpoint you want to get.
1165+
:param private_network: Private Network details.
1166+
1167+
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
1168+
:param public_network: Public network details.
1169+
1170+
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
11671171
:return: :class:`Endpoint <Endpoint>`
11681172
11691173
Usage:

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,13 +1093,20 @@ class UpdateEndpointRequest:
10931093
"""
10941094

10951095
endpoint_id: str
1096+
"""
1097+
UUID of the endpoint you want to get.
1098+
"""
10961099

10971100
private_network: Optional[EndpointSpecPrivateNetworkSpec]
10981101
"""
1102+
Private Network details.
1103+
10991104
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
11001105
"""
11011106

11021107
public_network: Optional[EndpointSpecPublicNetworkSpec]
11031108
"""
1109+
Public network details.
1110+
11041111
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
11051112
"""

scaleway/scaleway/redis/v1/api.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1161,9 +1161,13 @@ def update_endpoint(
11611161
Update an endpoint.
11621162
Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response.
11631163
:param zone: Zone to target. If none is passed will use default zone from the config.
1164-
:param endpoint_id:
1165-
:param private_network: One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
1166-
:param public_network: One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
1164+
:param endpoint_id: UUID of the endpoint you want to get.
1165+
:param private_network: Private Network details.
1166+
1167+
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
1168+
:param public_network: Public network details.
1169+
1170+
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
11671171
:return: :class:`Endpoint <Endpoint>`
11681172
11691173
Usage:

scaleway/scaleway/redis/v1/types.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,13 +1093,20 @@ class UpdateEndpointRequest:
10931093
"""
10941094

10951095
endpoint_id: str
1096+
"""
1097+
UUID of the endpoint you want to get.
1098+
"""
10961099

10971100
private_network: Optional[EndpointSpecPrivateNetworkSpec]
10981101
"""
1102+
Private Network details.
1103+
10991104
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
11001105
"""
11011106

11021107
public_network: Optional[EndpointSpecPublicNetworkSpec]
11031108
"""
1109+
Public network details.
1110+
11041111
One-of ('endpoint_type'): at most one of 'private_network', 'public_network' could be set.
11051112
"""

0 commit comments

Comments
 (0)