fix(channel): filter list --name server-side

channel list --name matched names client-side on the returned page only,
so with paging it missed channels on other pages, and it duplicated the
server-side query filter. Send the escaped text as the server's query
regex instead (same case-insensitive substring semantics, now also over
the description), drop the separate --query flag, and print the server's
total. Also list the valid --orderby values, and state precisely why the
audit and alert-event cursor/order fields are not exposed.

Author: ysyneu

internal/cli/channel.go

@@ -2,8 +2,8 @@ package cli
 
 import (
 	"fmt"
+	"regexp"
 	"strconv"
-	"strings"
 
 	"github.com/flashcatcloud/go-flashduty"
 	"github.com/spf13/cobra"
@@ -37,7 +37,7 @@ type channelRow struct {
 }
 
 func newChannelListCmd() *cobra.Command {
-	var name, channelName, query, orderby string
+	var name, channelName, orderby string
 	var teamIDs, channelIDs []int64
 	var page, limit int
 	var asc, isBrief, isMyManaged, isMyStarred, isMyTeam bool
@@ -48,17 +48,14 @@ func newChannelListCmd() *cobra.Command {
 		Long:  curatedLong("List channels in the account, optionally filtered by name or owning team.", "Channels", "ChannelList"),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runCommand(cmd, args, func(ctx *RunContext) error {
-				// Legacy parity: the hand-written SDK called /channel/list with an
-				// empty body and applied the --name filter client-side as a
-				// case-insensitive substring match. go-flashduty's ChannelName field
-				// is an exact-match server filter, so we keep the client-side filter
-				// to preserve behavior. --team-ids, by contrast, is a server-side
-				// filter on the channel's owning team (empty = all teams, unchanged).
+				// --name keeps its case-insensitive substring semantics by sending
+				// the escaped text as the server's query regex, so the match runs
+				// across every page instead of only the page returned.
 				req := &flashduty.ListChannelsRequest{
 					TeamIDs:     teamIDs,
 					ChannelIDs:  channelIDs,
 					ChannelName: channelName,
-					Query:       query,
+					Query:       regexp.QuoteMeta(name),
 					Orderby:     orderby,
 					Asc:         asc,
 					IsBrief:     isBrief,
@@ -79,9 +76,6 @@ func newChannelListCmd() *cobra.Command {
 
 				rows := make([]channelRow, 0, len(result.Items))
 				for _, ch := range result.Items {
-					if name != "" && !strings.Contains(strings.ToLower(ch.ChannelName), strings.ToLower(name)) {
-						continue
-					}
 					rows = append(rows, channelRow{
 						ChannelID:   ch.ChannelID,
 						ChannelName: ch.ChannelName,
@@ -102,20 +96,19 @@ func newChannelListCmd() *cobra.Command {
 					{Header: "CREATOR", Field: func(v any) string { return v.(channelRow).CreatorName }},
 				}
 
-				return ctx.PrintTotal(rows, cols, len(rows))
+				return ctx.PrintTotal(rows, cols, int(result.Total))
 			})
 		},
 	}
 
-	cmd.Flags().StringVar(&name, "name", "", "Search by name")
+	cmd.Flags().StringVar(&name, "name", "", "Case-insensitive substring of the channel name or description, server-side")
 	cmd.Flags().StringVar(&channelName, "channel-name", "", "Exact channel name, server-side")
-	cmd.Flags().StringVar(&query, "query", "", "Case-insensitive regex over channel name and description, server-side")
 	cmd.Flags().Int64SliceVar(&channelIDs, "channel-ids", nil, "Filter by channel ID(s) (repeatable or comma-separated)")
 	cmd.Flags().BoolVar(&isMyTeam, "is-my-team", false, "Only channels owned by your teams (exclusive with --is-my-starred)")
 	cmd.Flags().BoolVar(&isMyStarred, "is-my-starred", false, "Only channels you starred (exclusive with --is-my-team)")
 	cmd.Flags().BoolVar(&isMyManaged, "is-my-managed", false, "Only channels you manage")
 	cmd.Flags().BoolVar(&isBrief, "is-brief", false, "Return only id, name, description and status, all matches without pagination")
-	cmd.Flags().StringVar(&orderby, "orderby", "", "Sort field (server default: created_at)")
+	cmd.Flags().StringVar(&orderby, "orderby", "", "Sort field: ranking, created_at, updated_at, channel_name, or last_incident_at (server default: created_at)")
 	cmd.Flags().BoolVar(&asc, "asc", false, "Sort in ascending order")
 	cmd.Flags().IntVar(&page, "page", 1, "Page number")
 	cmd.Flags().IntVar(&limit, "limit", 100, "Page size (server default 100)")

internal/cli/curated_fields_test.go

@@ -48,7 +48,7 @@ var curatedFieldRoutes = map[string]map[string]string{
 		"start_time":        "--since",
 		"end_time":          "--until",
 		"p":                 "--page",
-		"orderby":           "omit: event_time is the only supported value and the server default",
+		"orderby":           "omit: event_time is the server default and the only order the server's paging cursor supports",
 		"search_after_ctx":  "omit: cursor returned by the previous page; the curated list pages with --page and does not print the next-page cursor",
 	},
 	"incident merge": {
@@ -62,7 +62,7 @@ var curatedFieldRoutes = map[string]map[string]string{
 		"end_time":         "--until",
 		"person_id":        "--person",
 		"operations":       "--operation",
-		"search_after_ctx": "omit: the cursor is managed by the command; --page walks it",
+		"search_after_ctx": "omit: --page walks the cursor by re-sending each response's search_after_ctx",
 	},
 	"change list": {
 		"start_time":      "--since",
@@ -75,7 +75,8 @@ var curatedFieldRoutes = map[string]map[string]string{
 		"data_source_ids": "omit: deprecated alias of integration_ids, which --integration sets",
 	},
 	"channel list": {
-		"p": "--page",
+		"p":     "--page",
+		"query": "--name",
 	},
 	"team list": {
 		"p":     "--page",

internal/cli/curated_misc_fields_test.go

@@ -59,10 +59,10 @@ func TestCuratedListFilterFlagsReachWireBody(t *testing.T) {
 		},
 		{
 			name: "channel filters and paging",
-			args: []string{"channel", "list", "--query", "^pay", "--channel-name", "payments", "--channel-ids", "1,2", "--is-my-team", "--is-my-managed", "--is-brief", "--orderby", "channel_name", "--asc", "--page", "2", "--limit", "10"},
+			args: []string{"channel", "list", "--name", "pay.ments", "--channel-name", "payments", "--channel-ids", "1,2", "--is-my-team", "--is-my-managed", "--is-brief", "--orderby", "channel_name", "--asc", "--page", "2", "--limit", "10"},
 			path: "/channel/list",
 			want: map[string]any{
-				"query": "^pay", "channel_name": "payments", "channel_ids": []any{float64(1), float64(2)},
+				"query": `pay\.ments`, "channel_name": "payments", "channel_ids": []any{float64(1), float64(2)},
 				"is_my_team": true, "is_my_managed": true, "is_brief": true,
 				"orderby": "channel_name", "asc": true, "p": float64(2), "limit": float64(10),
 			},

internal/cli/field.go

@@ -66,7 +66,7 @@ func newFieldListCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&name, "name", "", "Filter by field name")
-	cmd.Flags().StringVar(&query, "query", "", "Regex over field_name, server-side")
+	cmd.Flags().StringVar(&query, "query", "", "Case-insensitive regex over the field name, server-side")
 	cmd.Flags().Int64Var(&creatorID, "creator-id", 0, "Filter by creator member ID")
 	cmd.Flags().StringVar(&orderby, "orderby", "", "Sort key (server default: created_at)")
 	cmd.Flags().BoolVar(&asc, "asc", false, "Sort in ascending order")

skills/flashduty/reference/channel.md

@@ -89,7 +89,6 @@ List channels
 - `--name` string
 - `--orderby` string
 - `--page` int
-- `--query` string
 - `--team-ids` int64Slice
 - response: TOP-LEVEL array — pipe `--json | jq '.[]'` (NOT `.items[]`) — fields: account_id (integer); active_incident_highest_severity (string); auto_resolve_mode (string); auto_resolve_timeout (integer); channel_id (integer); channel_name (string); created_at (string); creator_id (integer); creator_name (string); deleted_at (string); description (string); disable_auto_close (boolean); disable_outlier_detection (boolean); event_group (object); external_report_token (string); flapping (object); group (object); is_external_report_enabled (boolean); is_private (boolean); is_starred (boolean); last_incident_at (string); managing_team_ids (array<integer>); progress_to_incident_cnts (object); status (string); team_id (integer); team_name (string); updated_at (string)