dnsimple / dnsimple/cli

Replace deprecated account email with account name in auth status

Open
#26 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
3
Forks
0
Avg merge
8h 39m
Merged PRs (30d)
9

Description

Summary

The CLI currently enriches auth status (and any future whoami-style output) using the email field of the Account API resource. That field is deprecated as part of dnsimple/dnsimple-business#2318, which removed the notion of an "account email". Once the API stops returning it, our enrichment will silently render a blank label next to the account ID.

We need to switch the CLI to use the account name as the human-readable identifier, once the API exposes it and the Go client is released with the change.

Background

  • dnsimple/dnsimple-business#2318 — closed — removed the concept of an account email and introduced a separate "notification email" plus "domain push identifier".
  • dnsimple/dnsimple-engineering#425 — open — tracks the corresponding API + API client work. Its acceptance criteria explicitly include:

    Add account name to /whoami, /accounts, /accounts/id

  • The motivation for opening this CLI ticket was discussed in dnsimple/dnsimple-engineering#425 (comment): while fixing dnsimple/dnsimple-cli#25 we noticed the SDK still exposes only email and there is no replacement field yet.

Current state

internal/cli/auth.go populates data.AccountEmail from Account.Email via Accounts.ListAccounts. Today the dnsimple-go v8.x Account struct only exposes:

type Account struct {
    ID             int64
    Email          string
    PlanIdentifier string
    CreatedAt      string
    UpdatedAt      string
}

There is no Name field yet, so we cannot make the change in the CLI in isolation.

Dependencies

This ticket is blocked on:

  • dnsimple/dnsimple-engineering#425 (API + SDK update)
  • A new dnsimple-go release that exposes the new field

References

  • dnsimple/dnsimple-engineering#425
  • dnsimple/dnsimple-cli#25 (the bug fix that surfaced this gap)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in internal/cli/auth.go, where auth status populates data.AccountEmail from Account.Email through Accounts.ListAccounts. Wait for dnsimple-engineering#425 and a dnsimple-go release exposing Account.Name, then update the enrichment and verify that auth status displays the account name instead of the deprecated email.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.