Skip to content

Commit d7c5943

Browse files
fix(edge_services): update quickstart (#1705)
Co-authored-by: esoulard <esoulard@scaleway.com>
1 parent af07857 commit d7c5943

4 files changed

Lines changed: 20 additions & 20 deletions

File tree

scaleway-async/scaleway_async/edge_services/v1beta1/api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2015,11 +2015,11 @@ async def create_route_stage(
20152015
) -> RouteStage:
20162016
"""
20172017
Create route stage.
2018-
Create a new route stage. You must specify the `waf_stage_id` field to customize the route.
2018+
Create a new route stage. You must specify the `waf_stage_id` or `backend_stage_id` fields to customize the route.
20192019
:param pipeline_id: Pipeline ID the route stage belongs to.
20202020
:param waf_stage_id: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
20212021
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
2022-
:param backend_stage_id:
2022+
:param backend_stage_id: ID of the backend stage HTTP requests should be forwarded to when no rules are matched.
20232023
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
20242024
:return: :class:`RouteStage <RouteStage>`
20252025
@@ -2091,7 +2091,7 @@ async def update_route_stage(
20912091
:param route_stage_id: ID of the route stage to update.
20922092
:param waf_stage_id: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
20932093
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
2094-
:param backend_stage_id:
2094+
:param backend_stage_id: ID of the backend stage HTTP requests should be forwarded to when no rules are matched.
20952095
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
20962096
:return: :class:`RouteStage <RouteStage>`
20972097
@@ -2187,7 +2187,7 @@ async def set_route_rules(
21872187
Set route rules.
21882188
Set the rules of an existing route stage, specified by its `route_stage_id`.
21892189
:param route_stage_id: ID of the route stage to update.
2190-
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
2190+
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
21912191
:return: :class:`SetRouteRulesResponse <SetRouteRulesResponse>`
21922192
21932193
Usage:
@@ -2227,7 +2227,7 @@ async def add_route_rules(
22272227
Add route rules.
22282228
Add route rules to an existing route stage, specified by its `route_stage_id`.
22292229
:param route_stage_id: ID of the route stage to update.
2230-
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
2230+
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
22312231
:param after_position: Add rules after the given position.
22322232
One-Of ('position'): at most one of 'after_position', 'before_position' could be set.
22332233
:param before_position: Add rules before the given position.

scaleway-async/scaleway_async/edge_services/v1beta1/types.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@ class AddRouteRulesRequest:
857857
default_factory=list
858858
)
859859
"""
860-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
860+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
861861
"""
862862

863863
after_position: Optional[int] = 0
@@ -869,7 +869,7 @@ class AddRouteRulesRequest:
869869
class AddRouteRulesResponse:
870870
route_rules: list[RouteRule]
871871
"""
872-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
872+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
873873
"""
874874

875875

@@ -1577,7 +1577,7 @@ class ListRouteRulesRequest:
15771577
class ListRouteRulesResponse:
15781578
route_rules: list[RouteRule]
15791579
"""
1580-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1580+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
15811581
"""
15821582

15831583
total_count: int
@@ -1774,15 +1774,15 @@ class SetRouteRulesRequest:
17741774
default_factory=list
17751775
)
17761776
"""
1777-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1777+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
17781778
"""
17791779

17801780

17811781
@dataclass
17821782
class SetRouteRulesResponse:
17831783
route_rules: list[RouteRule]
17841784
"""
1785-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1785+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
17861786
"""
17871787

17881788

scaleway/scaleway/edge_services/v1beta1/api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2013,11 +2013,11 @@ def create_route_stage(
20132013
) -> RouteStage:
20142014
"""
20152015
Create route stage.
2016-
Create a new route stage. You must specify the `waf_stage_id` field to customize the route.
2016+
Create a new route stage. You must specify the `waf_stage_id` or `backend_stage_id` fields to customize the route.
20172017
:param pipeline_id: Pipeline ID the route stage belongs to.
20182018
:param waf_stage_id: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
20192019
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
2020-
:param backend_stage_id:
2020+
:param backend_stage_id: ID of the backend stage HTTP requests should be forwarded to when no rules are matched.
20212021
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
20222022
:return: :class:`RouteStage <RouteStage>`
20232023
@@ -2089,7 +2089,7 @@ def update_route_stage(
20892089
:param route_stage_id: ID of the route stage to update.
20902090
:param waf_stage_id: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
20912091
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
2092-
:param backend_stage_id:
2092+
:param backend_stage_id: ID of the backend stage HTTP requests should be forwarded to when no rules are matched.
20932093
One-Of ('next'): at most one of 'waf_stage_id', 'backend_stage_id' could be set.
20942094
:return: :class:`RouteStage <RouteStage>`
20952095
@@ -2185,7 +2185,7 @@ def set_route_rules(
21852185
Set route rules.
21862186
Set the rules of an existing route stage, specified by its `route_stage_id`.
21872187
:param route_stage_id: ID of the route stage to update.
2188-
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
2188+
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
21892189
:return: :class:`SetRouteRulesResponse <SetRouteRulesResponse>`
21902190
21912191
Usage:
@@ -2225,7 +2225,7 @@ def add_route_rules(
22252225
Add route rules.
22262226
Add route rules to an existing route stage, specified by its `route_stage_id`.
22272227
:param route_stage_id: ID of the route stage to update.
2228-
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
2228+
:param route_rules: List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
22292229
:param after_position: Add rules after the given position.
22302230
One-Of ('position'): at most one of 'after_position', 'before_position' could be set.
22312231
:param before_position: Add rules before the given position.

scaleway/scaleway/edge_services/v1beta1/types.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@ class AddRouteRulesRequest:
857857
default_factory=list
858858
)
859859
"""
860-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
860+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
861861
"""
862862

863863
after_position: Optional[int] = 0
@@ -869,7 +869,7 @@ class AddRouteRulesRequest:
869869
class AddRouteRulesResponse:
870870
route_rules: list[RouteRule]
871871
"""
872-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
872+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
873873
"""
874874

875875

@@ -1577,7 +1577,7 @@ class ListRouteRulesRequest:
15771577
class ListRouteRulesResponse:
15781578
route_rules: list[RouteRule]
15791579
"""
1580-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1580+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
15811581
"""
15821582

15831583
total_count: int
@@ -1774,15 +1774,15 @@ class SetRouteRulesRequest:
17741774
default_factory=list
17751775
)
17761776
"""
1777-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1777+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
17781778
"""
17791779

17801780

17811781
@dataclass
17821782
class SetRouteRulesResponse:
17831783
route_rules: list[RouteRule]
17841784
"""
1785-
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`.
1785+
List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the stage defined by `waf_stage_id` or `backend_stage_id`.
17861786
"""
17871787

17881788

0 commit comments

Comments
 (0)