Skip to content

Commit 824df61

Browse files
scaleway-botyfodil
andauthored
docs(edge_services): add precision on forwarding behavior (#5445)
Co-authored-by: Yacine Fodil <105779815+yfodil@users.noreply.github.com>
1 parent 1f9fe0f commit 824df61

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

cmd/scw/testdata/test-all-usage-edge-services-route-stage-create-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a new route stage. You must specify the `waf_stage_id` field to customize the route.
3+
Create a new route stage. You must specify the `waf_stage_id` or `backend_stage_id` fields to customize the route.
44

55
USAGE:
66
scw edge-services route-stage create [arg=value ...]
77

88
ARGS:
99
pipeline-id Pipeline ID the route stage belongs to
1010
[waf-stage-id] ID of the WAF stage HTTP requests should be forwarded to when no rules are matched
11-
[backend-stage-id]
11+
[backend-stage-id] ID of the backend stage HTTP requests should be forwarded to when no rules are matched
1212

1313
FLAGS:
1414
-h, --help help for create

cmd/scw/testdata/test-all-usage-edge-services-route-stage-update-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ USAGE:
88
ARGS:
99
route-stage-id ID of the route stage to update
1010
[waf-stage-id] ID of the WAF stage HTTP requests should be forwarded to when no rules are matched
11-
[backend-stage-id]
11+
[backend-stage-id] ID of the backend stage HTTP requests should be forwarded to when no rules are matched
1212

1313
FLAGS:
1414
-h, --help help for update

docs/commands/edge-services.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ Route-stage management commands.
725725

726726
### Create route stage
727727

728-
Create a new route stage. You must specify the `waf_stage_id` field to customize the route.
728+
Create a new route stage. You must specify the `waf_stage_id` or `backend_stage_id` fields to customize the route.
729729

730730
**Usage:**
731731

@@ -740,7 +740,7 @@ scw edge-services route-stage create [arg=value ...]
740740
|------|---|-------------|
741741
| pipeline-id | Required | Pipeline ID the route stage belongs to |
742742
| waf-stage-id | | ID of the WAF stage HTTP requests should be forwarded to when no rules are matched |
743-
| backend-stage-id | | |
743+
| backend-stage-id | | ID of the backend stage HTTP requests should be forwarded to when no rules are matched |
744744

745745

746746

@@ -819,7 +819,7 @@ scw edge-services route-stage update <route-stage-id ...> [arg=value ...]
819819
|------|---|-------------|
820820
| route-stage-id | Required | ID of the route stage to update |
821821
| waf-stage-id | | ID of the WAF stage HTTP requests should be forwarded to when no rules are matched |
822-
| backend-stage-id | | |
822+
| backend-stage-id | | ID of the backend stage HTTP requests should be forwarded to when no rules are matched |
823823

824824

825825

internal/namespaces/edge_services/v1beta1/edge_services_cli.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1812,7 +1812,7 @@ func edgeServicesRouteStageList() *core.Command {
18121812
func edgeServicesRouteStageCreate() *core.Command {
18131813
return &core.Command{
18141814
Short: `Create route stage`,
1815-
Long: `Create a new route stage. You must specify the ` + "`" + `waf_stage_id` + "`" + ` field to customize the route.`,
1815+
Long: `Create a new route stage. You must specify the ` + "`" + `waf_stage_id` + "`" + ` or ` + "`" + `backend_stage_id` + "`" + ` fields to customize the route.`,
18161816
Namespace: "edge-services",
18171817
Resource: "route-stage",
18181818
Verb: "create",
@@ -1835,6 +1835,7 @@ func edgeServicesRouteStageCreate() *core.Command {
18351835
},
18361836
{
18371837
Name: "backend-stage-id",
1838+
Short: `ID of the backend stage HTTP requests should be forwarded to when no rules are matched`,
18381839
Required: false,
18391840
Deprecated: false,
18401841
Positional: false,
@@ -1906,6 +1907,7 @@ func edgeServicesRouteStageUpdate() *core.Command {
19061907
},
19071908
{
19081909
Name: "backend-stage-id",
1910+
Short: `ID of the backend stage HTTP requests should be forwarded to when no rules are matched`,
19091911
Required: false,
19101912
Deprecated: false,
19111913
Positional: false,

0 commit comments

Comments
 (0)