Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clearer documentation wording & data model for usernames & handles #239

Open
matheus23 opened this issue Feb 9, 2024 · 0 comments
Open
Assignees

Comments

@matheus23
Copy link
Member

Originally from comments from @hugomrdias:

we should describe better username, handle and domain in the context of this api

Where "this API" is:

  • the _did.<handle> DNS records
  • the GET /api/v0/account route and its returned Account record with the username field
  • the PATCH /api/v0/account/username/:username route
  • the PATCH /api/v0/account/handle/:handle route

some notes on username/handle :

  • username and handle should be more explicit
    • username should just be username hugomrdias
    • handle should be hugomrdias.fission.codes
    • account info uses username as <username>.<domain>
    • patch username uses username as <username>
    • patch handle uses handle as just the domain
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant