Skip to content

Commit aaab63a

Browse files
committed
docs: mark insight notifications as do-not-migrate (report API retiring)
The notifications command's backing report API (/report/* QueryNotificationTrend) is being retired, so it is intentionally excluded from go-flashduty's spec — there is no SDK method and there won't be one. Reword the TODO from a pending-migration note to an explicit do-not-migrate so it isn't re-pointed at the SDK later.
1 parent 5156982 commit aaab63a

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

internal/cli/insight.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -342,10 +342,11 @@ func newInsightNotificationsCmd() *cobra.Command {
342342
cmd := &cobra.Command{
343343
Use: "notifications",
344344
Short: "Query notification volume trends",
345-
// TODO(go-flashduty migration): not migrated. go-flashduty v0.4.0's
346-
// Analytics service has no notification-trend endpoint (only by-dimension
347-
// insight, top-k alerts, incident list/export). There is no matching
348-
// method, so this stays on the legacy SDK's QueryNotificationTrend.
345+
// DO NOT MIGRATE to go-flashduty. This command's backing report API
346+
// (QueryNotificationTrend, a /report/* endpoint) is being retired, so it
347+
// is intentionally excluded from go-flashduty's spec — there is no
348+
// go-flashduty method and there won't be one. It stays on the legacy SDK
349+
// until the feature itself is removed; do not re-point it at the SDK.
349350
RunE: func(cmd *cobra.Command, args []string) error {
350351
return runCommand(cmd, args, func(ctx *RunContext) error {
351352
startTime, err := timeutil.Parse(since)

0 commit comments

Comments
 (0)