Skip to content

feat(edge_services): add routing documentation #5399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
estellesoulard merged 6 commits into from
Mar 16, 2026
Merged

feat(edge_services): add routing documentation #5399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a77d119
feat: update generated APIs
scaleway-bot Mar 13, 2026
5bc4080
Merge branch 'main' into v1.7861.0
jremy42 Mar 16, 2026
48beb76
Merge branch 'main' into v1.7861.0
estellesoulard Mar 16, 2026
4568277
update golden
estellesoulard Mar 16, 2026
cdd6802
Merge branch 'main' into v1.7861.0
estellesoulard Mar 16, 2026
c68fc62
cleanup unrelated changes
estellesoulard Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-edge-services-route-rules-add-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[route-rules.{index}.rule-http-match.path-filter.path-filter-type] Type of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the `regex` type (unknown_path_filter | regex)
[route-rules.{index}.rule-http-match.path-filter.value] Value to be matched for the HTTP URL path
[route-rules.{index}.backend-stage-id] ID of the backend stage that requests matching the rule should be forwarded to
[route-rules.{index}.waf-stage-id]
[route-rules.{index}.waf-stage-id] ID of the WAF stage that requests matching the rule should be forwarded to
[after-position] Add rules after the given position
[before-position] Add rules before the given position

Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-edge-services-route-rules-set-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[route-rules.{index}.rule-http-match.path-filter.path-filter-type] Type of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the `regex` type (unknown_path_filter | regex)
[route-rules.{index}.rule-http-match.path-filter.value] Value to be matched for the HTTP URL path
[route-rules.{index}.backend-stage-id] ID of the backend stage that requests matching the rule should be forwarded to
[route-rules.{index}.waf-stage-id]
[route-rules.{index}.waf-stage-id] ID of the WAF stage that requests matching the rule should be forwarded to

FLAGS:
-h, --help help for set
Expand Down
5 changes: 3 additions & 2 deletions cmd/scw/testdata/test-all-usage-edge-services-route-stage-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ USAGE:
scw edge-services route-stage create [arg=value ...]

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

FLAGS:
-h, --help help for create
Expand Down
5 changes: 3 additions & 2 deletions cmd/scw/testdata/test-all-usage-edge-services-route-stage-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ USAGE:
scw edge-services route-stage update <route-stage-id ...> [arg=value ...]

ARGS:
route-stage-id ID of the route stage to update
[waf-stage-id] ID of the WAF stage HTTP requests should be forwarded to when no rules are matched
route-stage-id ID of the route stage to update
[waf-stage-id] ID of the WAF stage HTTP requests should be forwarded to when no rules are matched
[backend-stage-id]

FLAGS:
-h, --help help for update
Expand Down
6 changes: 4 additions & 2 deletions docs/commands/edge-services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,7 @@ scw edge-services route-rules add <route-stage-id ...> [arg=value ...]
| route-rules.{index}.rule-http-match.path-filter.path-filter-type | One of: `unknown_path_filter`, `regex` | Type of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the `regex` type |
| route-rules.{index}.rule-http-match.path-filter.value | | Value to be matched for the HTTP URL path |
| route-rules.{index}.backend-stage-id | | ID of the backend stage that requests matching the rule should be forwarded to |
| route-rules.{index}.waf-stage-id | | |
| route-rules.{index}.waf-stage-id | | ID of the WAF stage that requests matching the rule should be forwarded to |
| after-position | | Add rules after the given position |
| before-position | | Add rules before the given position |

Expand Down Expand Up @@ -712,7 +712,7 @@ scw edge-services route-rules set <route-stage-id ...> [arg=value ...]
| route-rules.{index}.rule-http-match.path-filter.path-filter-type | One of: `unknown_path_filter`, `regex` | Type of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the `regex` type |
| route-rules.{index}.rule-http-match.path-filter.value | | Value to be matched for the HTTP URL path |
| route-rules.{index}.backend-stage-id | | ID of the backend stage that requests matching the rule should be forwarded to |
| route-rules.{index}.waf-stage-id | | |
| route-rules.{index}.waf-stage-id | | ID of the WAF stage that requests matching the rule should be forwarded to |



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



Expand Down Expand Up @@ -816,6 +817,7 @@ scw edge-services route-stage update <route-stage-id ...> [arg=value ...]
|------|---|-------------|
| route-stage-id | Required | ID of the route stage to update |
| waf-stage-id | | ID of the WAF stage HTTP requests should be forwarded to when no rules are matched |
| backend-stage-id | | |



Expand Down
14 changes: 14 additions & 0 deletions internal/namespaces/edge_services/v1beta1/edge_services_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1819,6 +1819,12 @@ func edgeServicesRouteStageCreate() *core.Command {
Deprecated: false,
Positional: false,
},
{
Name: "backend-stage-id",
Required: false,
Deprecated: false,
Positional: false,
},
},
Run: func(ctx context.Context, args any) (i any, e error) {
request := args.(*edge_services.CreateRouteStageRequest)
Expand Down Expand Up @@ -1884,6 +1890,12 @@ func edgeServicesRouteStageUpdate() *core.Command {
Deprecated: false,
Positional: false,
},
{
Name: "backend-stage-id",
Required: false,
Deprecated: false,
Positional: false,
},
},
Run: func(ctx context.Context, args any) (i any, e error) {
request := args.(*edge_services.UpdateRouteStageRequest)
Expand Down Expand Up @@ -2022,6 +2034,7 @@ func edgeServicesRouteRulesSet() *core.Command {
},
{
Name: "route-rules.{index}.waf-stage-id",
Short: `ID of the WAF stage that requests matching the rule should be forwarded to`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -2099,6 +2112,7 @@ func edgeServicesRouteRulesAdd() *core.Command {
},
{
Name: "route-rules.{index}.waf-stage-id",
Short: `ID of the WAF stage that requests matching the rule should be forwarded to`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down
Loading