feat(edge_services): add doc and cli for head stage (#5264)

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-edge-services-pipeline-list-head-usage.golden

@@ -0,0 +1,18 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+List Head stage for your pipeline.
+
+USAGE:
+  scw edge-services pipeline list-head <pipeline-id ...> [arg=value ...]
+
+ARGS:
+  pipeline-id   ID of the pipeline to update
+
+FLAGS:
+  -h, --help   help for list-head
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use

cmd/scw/testdata/test-all-usage-edge-services-pipeline-set-head-usage.golden

@@ -0,0 +1,22 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+You must specify either a `add_new_head_stage` (to add a new head stage), `remove_head_stage` (to remove a head stage) or `swap_head_stage` (to replace a head stage).
+
+USAGE:
+  scw edge-services pipeline set-head <pipeline-id ...> [arg=value ...]
+
+ARGS:
+  pipeline-id                           ID of the pipeline to update
+  [add-new-head-stage.new-stage-id]     
+  [remove-head-stage.remove-stage-id]   
+  [swap-head-stage.new-stage-id]        
+  [swap-head-stage.current-stage-id]    
+
+FLAGS:
+  -h, --help   help for set-head
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use

cmd/scw/testdata/test-all-usage-edge-services-pipeline-usage.golden

@@ -10,6 +10,8 @@ AVAILABLE COMMANDS:
   delete      Delete pipeline
   get         Get pipeline
   list        List pipelines
+  list-head   List Head stage for your pipeline.
+  set-head    Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.
   update      Update pipeline
 
 FLAGS:

docs/commands/edge-services.md

@@ -25,6 +25,8 @@ Edge Services API
   - [Delete pipeline](#delete-pipeline)
   - [Get pipeline](#get-pipeline)
   - [List pipelines](#list-pipelines)
+  - [List Head stage for your pipeline.](#list-head-stage-for-your-pipeline.)
+  - [Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.](#configure-a-entry-point-to-your-pipeline.-you-must-specify-a-`head-stage`-to-form-a-stage-chain-that-goes-all-the-way-to-the-backend-stage-(origin),-so-the-http-request-will-be-processed-according-to-the-stages-you-created.)
   - [Update pipeline](#update-pipeline)
 - [Purge-request management commands](#purge-request-management-commands)
   - [Create purge request](#create-purge-request)
@@ -493,6 +495,48 @@ scw edge-services pipeline list [arg=value ...]
 
 
 
+### List Head stage for your pipeline.
+
+List Head stage for your pipeline.
+
+**Usage:**
+
+```
+scw edge-services pipeline list-head <pipeline-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pipeline-id | Required | ID of the pipeline to update |
+
+
+
+### Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.
+
+You must specify either a `add_new_head_stage` (to add a new head stage), `remove_head_stage` (to remove a head stage) or `swap_head_stage` (to replace a head stage).
+
+**Usage:**
+
+```
+scw edge-services pipeline set-head <pipeline-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pipeline-id | Required | ID of the pipeline to update |
+| add-new-head-stage.new-stage-id |  |  |
+| remove-head-stage.remove-stage-id |  |  |
+| swap-head-stage.new-stage-id |  |  |
+| swap-head-stage.current-stage-id |  |  |
+
+
+
 ### Update pipeline
 
 Update the parameters of an existing pipeline, specified by its `pipeline_id`. Parameters which can be updated include the `name`, `description` and `dns_stage_id`.

go.mod

@@ -23,7 +23,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20
 	github.com/moby/buildkit v0.26.3
 	github.com/opencontainers/go-digest v1.0.0
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.36.0.20260107085608-8e8f76c5afac
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.36.0.20260107155641-2ffb96c688ff
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
 	github.com/spf13/cobra v1.10.2
 	github.com/spf13/pflag v1.0.10

go.sum

@@ -468,8 +468,8 @@ github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.36.0.20260107085608-8e8f76c5afac h1:6k+C/FKpLBvJgjFZXqxQsOaUAwnFM9VDUIaQgtHxL84=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.36.0.20260107085608-8e8f76c5afac/go.mod h1:LEsDu4BubxK7/cWhtlQWfuxwL4rf/2UEpxXz1o1EMtM=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.36.0.20260107155641-2ffb96c688ff h1:URB4cZn80sXINbi3UR47Z6j5+I3g8koA5lXp85kIUk8=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.36.0.20260107155641-2ffb96c688ff/go.mod h1:LEsDu4BubxK7/cWhtlQWfuxwL4rf/2UEpxXz1o1EMtM=
 github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
 github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
 github.com/secure-systems-lab/go-securesystemslib v0.9.1 h1:nZZaNz4DiERIQguNy0cL5qTdn9lR8XKHf4RUyG1Sx3g=

internal/namespaces/edge_services/v1beta1/edge_services_cli.go

@@ -34,6 +34,8 @@ func GetGeneratedCommands() *core.Commands {
 		edgeServicesPipelineGet(),
 		edgeServicesPipelineUpdate(),
 		edgeServicesPipelineDelete(),
+		edgeServicesPipelineListHead(),
+		edgeServicesPipelineSetHead(),
 		edgeServicesDNSStageList(),
 		edgeServicesDNSStageCreate(),
 		edgeServicesDNSStageGet(),
@@ -375,6 +377,93 @@ func edgeServicesPipelineDelete() *core.Command {
 	}
 }
 
+func edgeServicesPipelineListHead() *core.Command {
+	return &core.Command{
+		Short:     `List Head stage for your pipeline.`,
+		Long:      `List Head stage for your pipeline.`,
+		Namespace: "edge-services",
+		Resource:  "pipeline",
+		Verb:      "list-head",
+		// Deprecated:    false,
+		ArgsType: reflect.TypeOf(edge_services.ListHeadStagesRequest{}),
+		ArgSpecs: core.ArgSpecs{
+			{
+				Name:       "pipeline-id",
+				Short:      `ID of the pipeline to update`,
+				Required:   true,
+				Deprecated: false,
+				Positional: true,
+			},
+		},
+		Run: func(ctx context.Context, args any) (i any, e error) {
+			request := args.(*edge_services.ListHeadStagesRequest)
+
+			client := core.ExtractClient(ctx)
+			api := edge_services.NewAPI(client)
+			opts := []scw.RequestOption{scw.WithAllPages()}
+			resp, err := api.ListHeadStages(request, opts...)
+			if err != nil {
+				return nil, err
+			}
+
+			return resp.HeadStages, nil
+		},
+	}
+}
+
+func edgeServicesPipelineSetHead() *core.Command {
+	return &core.Command{
+		Short:     `Configure a entry point to your pipeline. You must specify a ` + "`" + `head stage` + "`" + ` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.`,
+		Long:      `You must specify either a ` + "`" + `add_new_head_stage` + "`" + ` (to add a new head stage), ` + "`" + `remove_head_stage` + "`" + ` (to remove a head stage) or ` + "`" + `swap_head_stage` + "`" + ` (to replace a head stage).`,
+		Namespace: "edge-services",
+		Resource:  "pipeline",
+		Verb:      "set-head",
+		// Deprecated:    false,
+		ArgsType: reflect.TypeOf(edge_services.SetHeadStageRequest{}),
+		ArgSpecs: core.ArgSpecs{
+			{
+				Name:       "pipeline-id",
+				Short:      `ID of the pipeline to update`,
+				Required:   true,
+				Deprecated: false,
+				Positional: true,
+			},
+			{
+				Name:       "add-new-head-stage.new-stage-id",
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "remove-head-stage.remove-stage-id",
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "swap-head-stage.new-stage-id",
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+			{
+				Name:       "swap-head-stage.current-stage-id",
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
+		},
+		Run: func(ctx context.Context, args any) (i any, e error) {
+			request := args.(*edge_services.SetHeadStageRequest)
+
+			client := core.ExtractClient(ctx)
+			api := edge_services.NewAPI(client)
+
+			return api.SetHeadStage(request)
+		},
+	}
+}
+
 func edgeServicesDNSStageList() *core.Command {
 	return &core.Command{
 		Short:     `List DNS stages`,