Skip to content

Commit 47b4433

Browse files
authored
docs(lb): hide new ipmob fields (#209)
1 parent d0ddc1b commit 47b4433

File tree

4 files changed

+66
-2
lines changed

4 files changed

+66
-2
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1945,6 +1945,7 @@ async def list_backend_stats(
19451945
region: Optional[Region] = None,
19461946
page: Optional[int] = None,
19471947
page_size: Optional[int] = None,
1948+
backend_id: Optional[str] = None,
19481949
) -> ListBackendStatsResponse:
19491950
"""
19501951
@@ -1963,6 +1964,7 @@ async def list_backend_stats(
19631964
"GET",
19641965
f"/lb/v1/regions/{param_region}/lbs/{param_lb_id}/backend-stats",
19651966
params={
1967+
"backend_id": backend_id,
19661968
"page": page,
19671969
"page_size": page_size or self.client.default_page_size,
19681970
},
@@ -1978,6 +1980,7 @@ async def list_backend_stats_all(
19781980
region: Optional[Region] = None,
19791981
page: Optional[int] = None,
19801982
page_size: Optional[int] = None,
1983+
backend_id: Optional[str] = None,
19811984
) -> List[BackendServerStats]:
19821985
"""
19831986
:return: :class:`List[ListBackendStatsResponse] <List[ListBackendStatsResponse]>`
@@ -1997,6 +2000,7 @@ async def list_backend_stats_all(
19972000
"region": region,
19982001
"page": page,
19992002
"page_size": page_size,
2003+
"backend_id": backend_id,
20002004
},
20012005
)
20022006

@@ -4846,6 +4850,7 @@ async def list_backend_stats(
48464850
zone: Optional[Zone] = None,
48474851
page: Optional[int] = None,
48484852
page_size: Optional[int] = None,
4853+
backend_id: Optional[str] = None,
48494854
) -> ListBackendStatsResponse:
48504855
"""
48514856
List backend server statistics.
@@ -4854,6 +4859,7 @@ async def list_backend_stats(
48544859
:param lb_id: Load Balancer ID.
48554860
:param page: The page number to return, from the paginated results.
48564861
:param page_size: Number of items to return.
4862+
:param backend_id: ID of the backend.
48574863
:return: :class:`ListBackendStatsResponse <ListBackendStatsResponse>`
48584864
48594865
Usage:
@@ -4869,6 +4875,7 @@ async def list_backend_stats(
48694875
"GET",
48704876
f"/lb/v1/zones/{param_zone}/lbs/{param_lb_id}/backend-stats",
48714877
params={
4878+
"backend_id": backend_id,
48724879
"page": page,
48734880
"page_size": page_size or self.client.default_page_size,
48744881
},
@@ -4884,6 +4891,7 @@ async def list_backend_stats_all(
48844891
zone: Optional[Zone] = None,
48854892
page: Optional[int] = None,
48864893
page_size: Optional[int] = None,
4894+
backend_id: Optional[str] = None,
48874895
) -> List[BackendServerStats]:
48884896
"""
48894897
List backend server statistics.
@@ -4892,6 +4900,7 @@ async def list_backend_stats_all(
48924900
:param lb_id: Load Balancer ID.
48934901
:param page: The page number to return, from the paginated results.
48944902
:param page_size: Number of items to return.
4903+
:param backend_id: ID of the backend.
48954904
:return: :class:`List[ListBackendStatsResponse] <List[ListBackendStatsResponse]>`
48964905
48974906
Usage:
@@ -4909,6 +4918,7 @@ async def list_backend_stats_all(
49094918
"zone": zone,
49104919
"page": page,
49114920
"page_size": page_size,
4921+
"backend_id": backend_id,
49124922
},
49134923
)
49144924

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

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ class AclActionRedirect:
348348

349349
target: str
350350
"""
351-
Redirect target. For a location redirect, you can use a URL e.g. `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a `location` redirect to preserve parts of the original request in the redirection URL are {{ host }}, {{ query }}, {{ path }} and {{ scheme }}.
351+
Redirect target. For a location redirect, you can use a URL e.g. `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a `location` redirect to preserve parts of the original request in the redirection URL are \{\{ host \}\}, \{\{ query \}\}, \{\{ path \}\} and \{\{ scheme \}\}.
352352
"""
353353

354354
code: Optional[int]
@@ -1660,6 +1660,12 @@ class CreateLbRequest:
16601660
ip_id: Optional[str]
16611661
"""
16621662
ID of an existing flexible IP address to attach to the Load Balancer.
1663+
:deprecated
1664+
"""
1665+
1666+
assign_flexible_ip: Optional[bool]
1667+
"""
1668+
Defines whether to automatically assign a flexible public IP to lb. Default value is `false` (do not assign).
16631669
"""
16641670

16651671
assign_flexible_ip: Optional[bool]
@@ -2600,6 +2606,11 @@ class ListBackendStatsRequest:
26002606
Number of items to return.
26012607
"""
26022608

2609+
backend_id: Optional[str]
2610+
"""
2611+
ID of the backend.
2612+
"""
2613+
26032614

26042615
@dataclass
26052616
class ListAclsRequest:
@@ -3190,6 +3201,12 @@ class ZonedApiCreateLbRequest:
31903201
ip_id: Optional[str]
31913202
"""
31923203
ID of an existing flexible IP address to attach to the Load Balancer.
3204+
:deprecated
3205+
"""
3206+
3207+
assign_flexible_ip: Optional[bool]
3208+
"""
3209+
Defines whether to automatically assign a flexible public IP to lb. Default value is `false` (do not assign).
31933210
"""
31943211

31953212
assign_flexible_ip: Optional[bool]
@@ -4130,6 +4147,11 @@ class ZonedApiListBackendStatsRequest:
41304147
Number of items to return.
41314148
"""
41324149

4150+
backend_id: Optional[str]
4151+
"""
4152+
ID of the backend.
4153+
"""
4154+
41334155

41344156
@dataclass
41354157
class ZonedApiListAclsRequest:

scaleway/scaleway/lb/v1/api.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1945,6 +1945,7 @@ def list_backend_stats(
19451945
region: Optional[Region] = None,
19461946
page: Optional[int] = None,
19471947
page_size: Optional[int] = None,
1948+
backend_id: Optional[str] = None,
19481949
) -> ListBackendStatsResponse:
19491950
"""
19501951
@@ -1963,6 +1964,7 @@ def list_backend_stats(
19631964
"GET",
19641965
f"/lb/v1/regions/{param_region}/lbs/{param_lb_id}/backend-stats",
19651966
params={
1967+
"backend_id": backend_id,
19661968
"page": page,
19671969
"page_size": page_size or self.client.default_page_size,
19681970
},
@@ -1978,6 +1980,7 @@ def list_backend_stats_all(
19781980
region: Optional[Region] = None,
19791981
page: Optional[int] = None,
19801982
page_size: Optional[int] = None,
1983+
backend_id: Optional[str] = None,
19811984
) -> List[BackendServerStats]:
19821985
"""
19831986
:return: :class:`List[ListBackendStatsResponse] <List[ListBackendStatsResponse]>`
@@ -1997,6 +2000,7 @@ def list_backend_stats_all(
19972000
"region": region,
19982001
"page": page,
19992002
"page_size": page_size,
2003+
"backend_id": backend_id,
20002004
},
20012005
)
20022006

@@ -4844,6 +4848,7 @@ def list_backend_stats(
48444848
zone: Optional[Zone] = None,
48454849
page: Optional[int] = None,
48464850
page_size: Optional[int] = None,
4851+
backend_id: Optional[str] = None,
48474852
) -> ListBackendStatsResponse:
48484853
"""
48494854
List backend server statistics.
@@ -4852,6 +4857,7 @@ def list_backend_stats(
48524857
:param lb_id: Load Balancer ID.
48534858
:param page: The page number to return, from the paginated results.
48544859
:param page_size: Number of items to return.
4860+
:param backend_id: ID of the backend.
48554861
:return: :class:`ListBackendStatsResponse <ListBackendStatsResponse>`
48564862
48574863
Usage:
@@ -4867,6 +4873,7 @@ def list_backend_stats(
48674873
"GET",
48684874
f"/lb/v1/zones/{param_zone}/lbs/{param_lb_id}/backend-stats",
48694875
params={
4876+
"backend_id": backend_id,
48704877
"page": page,
48714878
"page_size": page_size or self.client.default_page_size,
48724879
},
@@ -4882,6 +4889,7 @@ def list_backend_stats_all(
48824889
zone: Optional[Zone] = None,
48834890
page: Optional[int] = None,
48844891
page_size: Optional[int] = None,
4892+
backend_id: Optional[str] = None,
48854893
) -> List[BackendServerStats]:
48864894
"""
48874895
List backend server statistics.
@@ -4890,6 +4898,7 @@ def list_backend_stats_all(
48904898
:param lb_id: Load Balancer ID.
48914899
:param page: The page number to return, from the paginated results.
48924900
:param page_size: Number of items to return.
4901+
:param backend_id: ID of the backend.
48934902
:return: :class:`List[ListBackendStatsResponse] <List[ListBackendStatsResponse]>`
48944903
48954904
Usage:
@@ -4907,6 +4916,7 @@ def list_backend_stats_all(
49074916
"zone": zone,
49084917
"page": page,
49094918
"page_size": page_size,
4919+
"backend_id": backend_id,
49104920
},
49114921
)
49124922

scaleway/scaleway/lb/v1/types.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ class AclActionRedirect:
348348

349349
target: str
350350
"""
351-
Redirect target. For a location redirect, you can use a URL e.g. `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a `location` redirect to preserve parts of the original request in the redirection URL are {{ host }}, {{ query }}, {{ path }} and {{ scheme }}.
351+
Redirect target. For a location redirect, you can use a URL e.g. `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a `location` redirect to preserve parts of the original request in the redirection URL are \{\{ host \}\}, \{\{ query \}\}, \{\{ path \}\} and \{\{ scheme \}\}.
352352
"""
353353

354354
code: Optional[int]
@@ -1660,6 +1660,12 @@ class CreateLbRequest:
16601660
ip_id: Optional[str]
16611661
"""
16621662
ID of an existing flexible IP address to attach to the Load Balancer.
1663+
:deprecated
1664+
"""
1665+
1666+
assign_flexible_ip: Optional[bool]
1667+
"""
1668+
Defines whether to automatically assign a flexible public IP to lb. Default value is `false` (do not assign).
16631669
"""
16641670

16651671
assign_flexible_ip: Optional[bool]
@@ -2600,6 +2606,11 @@ class ListBackendStatsRequest:
26002606
Number of items to return.
26012607
"""
26022608

2609+
backend_id: Optional[str]
2610+
"""
2611+
ID of the backend.
2612+
"""
2613+
26032614

26042615
@dataclass
26052616
class ListAclsRequest:
@@ -3190,6 +3201,12 @@ class ZonedApiCreateLbRequest:
31903201
ip_id: Optional[str]
31913202
"""
31923203
ID of an existing flexible IP address to attach to the Load Balancer.
3204+
:deprecated
3205+
"""
3206+
3207+
assign_flexible_ip: Optional[bool]
3208+
"""
3209+
Defines whether to automatically assign a flexible public IP to lb. Default value is `false` (do not assign).
31933210
"""
31943211

31953212
assign_flexible_ip: Optional[bool]
@@ -4130,6 +4147,11 @@ class ZonedApiListBackendStatsRequest:
41304147
Number of items to return.
41314148
"""
41324149

4150+
backend_id: Optional[str]
4151+
"""
4152+
ID of the backend.
4153+
"""
4154+
41334155

41344156
@dataclass
41354157
class ZonedApiListAclsRequest:

0 commit comments

Comments
 (0)