diff --git a/docs/stackit_network-area_routing-table.md b/docs/stackit_network-area_routing-table.md index b39b4468e..2ba21deef 100644 --- a/docs/stackit_network-area_routing-table.md +++ b/docs/stackit_network-area_routing-table.md @@ -4,7 +4,7 @@ Manage routing-tables and its according routes ### Synopsis -Manage routing-tables and their associated routes. +Manage routing-tables and their associated routes within STACKIT Network Areas (SNAs). This API is currently available only to selected customers. To request access, please contact your account manager or submit a support ticket. diff --git a/docs/stackit_network-area_routing-table_create.md b/docs/stackit_network-area_routing-table_create.md index e4af0401d..7b540a23d 100644 --- a/docs/stackit_network-area_routing-table_create.md +++ b/docs/stackit_network-area_routing-table_create.md @@ -4,7 +4,7 @@ Creates a routing-table ### Synopsis -Creates a routing-table. +Creates a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table create [flags] diff --git a/docs/stackit_network-area_routing-table_delete.md b/docs/stackit_network-area_routing-table_delete.md index 71225b8fd..b2afa5d91 100644 --- a/docs/stackit_network-area_routing-table_delete.md +++ b/docs/stackit_network-area_routing-table_delete.md @@ -4,7 +4,7 @@ Deletes a routing-table ### Synopsis -Deletes a routing-table +Deletes a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table delete ROUTING_TABLE_ID [flags] diff --git a/docs/stackit_network-area_routing-table_describe.md b/docs/stackit_network-area_routing-table_describe.md index cce4804c4..71572c901 100644 --- a/docs/stackit_network-area_routing-table_describe.md +++ b/docs/stackit_network-area_routing-table_describe.md @@ -4,7 +4,7 @@ Describes a routing-table ### Synopsis -Describes a routing-table +Describes a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table describe ROUTING_TABLE_ID [flags] diff --git a/docs/stackit_network-area_routing-table_list.md b/docs/stackit_network-area_routing-table_list.md index 63660ca06..4970e23d9 100644 --- a/docs/stackit_network-area_routing-table_list.md +++ b/docs/stackit_network-area_routing-table_list.md @@ -4,7 +4,7 @@ Lists all routing-tables ### Synopsis -Lists all routing-tables +Lists all routing-tables within a STACKIT Network Area (SNA). ``` stackit network-area routing-table list [flags] diff --git a/docs/stackit_network-area_routing-table_route.md b/docs/stackit_network-area_routing-table_route.md index 8424f8203..b566f01de 100644 --- a/docs/stackit_network-area_routing-table_route.md +++ b/docs/stackit_network-area_routing-table_route.md @@ -4,7 +4,7 @@ Manages routes of a routing-table ### Synopsis -Manages routes of a routing-table +Manages routes of a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table route [flags] diff --git a/docs/stackit_network-area_routing-table_route_create.md b/docs/stackit_network-area_routing-table_route_create.md index 80984448a..a1fffa4cb 100644 --- a/docs/stackit_network-area_routing-table_route_create.md +++ b/docs/stackit_network-area_routing-table_route_create.md @@ -4,7 +4,7 @@ Creates a route in a routing-table ### Synopsis -Creates a route in a routing-table. +Creates a route in a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table route create [flags] diff --git a/docs/stackit_network-area_routing-table_route_delete.md b/docs/stackit_network-area_routing-table_route_delete.md index 80f5dcbd0..ad333cc5a 100644 --- a/docs/stackit_network-area_routing-table_route_delete.md +++ b/docs/stackit_network-area_routing-table_route_delete.md @@ -4,7 +4,7 @@ Deletes a route within a routing-table ### Synopsis -Deletes a route within a routing-table +Deletes a route within a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table route delete routing-table-id [flags] diff --git a/docs/stackit_network-area_routing-table_route_describe.md b/docs/stackit_network-area_routing-table_route_describe.md index 7eec6bd57..3f4d684b3 100644 --- a/docs/stackit_network-area_routing-table_route_describe.md +++ b/docs/stackit_network-area_routing-table_route_describe.md @@ -4,7 +4,7 @@ Describes a route within a routing-table ### Synopsis -Describes a route within a routing-table +Describes a route within a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table route describe ROUTE_ID [flags] diff --git a/docs/stackit_network-area_routing-table_route_list.md b/docs/stackit_network-area_routing-table_route_list.md index 1cfde45e7..616a85ec8 100644 --- a/docs/stackit_network-area_routing-table_route_list.md +++ b/docs/stackit_network-area_routing-table_route_list.md @@ -4,7 +4,7 @@ Lists all routes within a routing-table ### Synopsis -Lists all routes within a routing-table +Lists all routes within a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table route list [flags] diff --git a/docs/stackit_network-area_routing-table_route_update.md b/docs/stackit_network-area_routing-table_route_update.md index aa6daec2b..634299af1 100644 --- a/docs/stackit_network-area_routing-table_route_update.md +++ b/docs/stackit_network-area_routing-table_route_update.md @@ -4,7 +4,7 @@ Updates a route in a routing-table ### Synopsis -Updates a route in a routing-table. +Updates a route in a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table route update ROUTE_ID [flags] diff --git a/docs/stackit_network-area_routing-table_update.md b/docs/stackit_network-area_routing-table_update.md index b6803179a..897a5116b 100644 --- a/docs/stackit_network-area_routing-table_update.md +++ b/docs/stackit_network-area_routing-table_update.md @@ -4,7 +4,7 @@ Updates a routing-table ### Synopsis -Updates a routing-table. +Updates a routing-table within a STACKIT Network Area (SNA). ``` stackit network-area routing-table update ROUTING_TABLE_ID [flags] diff --git a/internal/cmd/network-area/routingtable/create/create.go b/internal/cmd/network-area/routingtable/create/create.go index e1583e50d..af25c9738 100644 --- a/internal/cmd/network-area/routingtable/create/create.go +++ b/internal/cmd/network-area/routingtable/create/create.go @@ -42,7 +42,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: "create", Short: "Creates a routing-table", - Long: "Creates a routing-table.", + Long: "Creates a routing-table within a STACKIT Network Area (SNA).", Args: args.NoArgs, Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/delete/delete.go b/internal/cmd/network-area/routingtable/delete/delete.go index 07b7aedc9..f3e131d96 100644 --- a/internal/cmd/network-area/routingtable/delete/delete.go +++ b/internal/cmd/network-area/routingtable/delete/delete.go @@ -34,7 +34,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("delete %s", routingTableIdArg), Short: "Deletes a routing-table", - Long: "Deletes a routing-table", + Long: "Deletes a routing-table within a STACKIT Network Area (SNA).", Args: args.SingleArg(routingTableIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/describe/describe.go b/internal/cmd/network-area/routingtable/describe/describe.go index a4b81ad87..736d30675 100644 --- a/internal/cmd/network-area/routingtable/describe/describe.go +++ b/internal/cmd/network-area/routingtable/describe/describe.go @@ -36,7 +36,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("describe %s", routingTableIdArg), Short: "Describes a routing-table", - Long: "Describes a routing-table", + Long: "Describes a routing-table within a STACKIT Network Area (SNA).", Args: args.SingleArg(routingTableIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/list/list.go b/internal/cmd/network-area/routingtable/list/list.go index 01c8c8e25..b44907f09 100644 --- a/internal/cmd/network-area/routingtable/list/list.go +++ b/internal/cmd/network-area/routingtable/list/list.go @@ -39,7 +39,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: "list", Short: "Lists all routing-tables", - Long: "Lists all routing-tables", + Long: "Lists all routing-tables within a STACKIT Network Area (SNA).", Args: args.NoArgs, Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/route/create/create.go b/internal/cmd/network-area/routingtable/route/create/create.go index c43f94af5..cbf0eed63 100644 --- a/internal/cmd/network-area/routingtable/route/create/create.go +++ b/internal/cmd/network-area/routingtable/route/create/create.go @@ -70,7 +70,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: "create", Short: "Creates a route in a routing-table", - Long: "Creates a route in a routing-table.", + Long: "Creates a route in a routing-table within a STACKIT Network Area (SNA).", Args: args.NoArgs, Example: examples.Build( examples.NewExample("Create a route with CIDRv4 destination and IPv4 nexthop", diff --git a/internal/cmd/network-area/routingtable/route/delete/delete.go b/internal/cmd/network-area/routingtable/route/delete/delete.go index b36069e4b..dc6f9bcaf 100644 --- a/internal/cmd/network-area/routingtable/route/delete/delete.go +++ b/internal/cmd/network-area/routingtable/route/delete/delete.go @@ -36,7 +36,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("delete %s", routingTableIdFlag), Short: "Deletes a route within a routing-table", - Long: "Deletes a route within a routing-table", + Long: "Deletes a route within a routing-table within a STACKIT Network Area (SNA).", Args: args.SingleArg(routeIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/route/describe/describe.go b/internal/cmd/network-area/routingtable/route/describe/describe.go index ddca7c823..bebbf2c69 100644 --- a/internal/cmd/network-area/routingtable/route/describe/describe.go +++ b/internal/cmd/network-area/routingtable/route/describe/describe.go @@ -39,7 +39,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("describe %s", routeIdArg), Short: "Describes a route within a routing-table", - Long: "Describes a route within a routing-table", + Long: "Describes a route within a routing-table within a STACKIT Network Area (SNA).", Args: args.SingleArg(routeIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/route/list/list.go b/internal/cmd/network-area/routingtable/route/list/list.go index bf396ff8a..fadef43c7 100644 --- a/internal/cmd/network-area/routingtable/route/list/list.go +++ b/internal/cmd/network-area/routingtable/route/list/list.go @@ -41,7 +41,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: "list", Short: "Lists all routes within a routing-table", - Long: "Lists all routes within a routing-table", + Long: "Lists all routes within a routing-table within a STACKIT Network Area (SNA).", Args: args.NoArgs, Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/route/route.go b/internal/cmd/network-area/routingtable/route/route.go index 7b2d05559..63ca945fd 100644 --- a/internal/cmd/network-area/routingtable/route/route.go +++ b/internal/cmd/network-area/routingtable/route/route.go @@ -17,7 +17,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: "route", Short: "Manages routes of a routing-table", - Long: "Manages routes of a routing-table", + Long: "Manages routes of a routing-table within a STACKIT Network Area (SNA).", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/network-area/routingtable/route/update/update.go b/internal/cmd/network-area/routingtable/route/update/update.go index 11ae98d72..67e2e937b 100644 --- a/internal/cmd/network-area/routingtable/route/update/update.go +++ b/internal/cmd/network-area/routingtable/route/update/update.go @@ -40,7 +40,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("update %s", routeIdArg), Short: "Updates a route in a routing-table", - Long: "Updates a route in a routing-table.", + Long: "Updates a route in a routing-table within a STACKIT Network Area (SNA).", Args: args.SingleArg(routeIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/network-area/routingtable/routingtable.go b/internal/cmd/network-area/routingtable/routingtable.go index 514d8146a..d00c7b6fd 100644 --- a/internal/cmd/network-area/routingtable/routingtable.go +++ b/internal/cmd/network-area/routingtable/routingtable.go @@ -18,7 +18,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: "routing-table", Short: "Manage routing-tables and its according routes", - Long: `Manage routing-tables and their associated routes. + Long: `Manage routing-tables and their associated routes within STACKIT Network Areas (SNAs). This API is currently available only to selected customers. To request access, please contact your account manager or submit a support ticket.`, diff --git a/internal/cmd/network-area/routingtable/update/update.go b/internal/cmd/network-area/routingtable/update/update.go index bdee91c1d..1f7062108 100644 --- a/internal/cmd/network-area/routingtable/update/update.go +++ b/internal/cmd/network-area/routingtable/update/update.go @@ -45,7 +45,7 @@ func NewCmd(params *types.CmdParams) *cobra.Command { cmd := &cobra.Command{ Use: fmt.Sprintf("update %s", routingTableIdArg), Short: "Updates a routing-table", - Long: "Updates a routing-table.", + Long: "Updates a routing-table within a STACKIT Network Area (SNA).", Args: args.SingleArg(routingTableIdArg, utils.ValidateUUID), Example: examples.Build( examples.NewExample(