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

Improve naming of API endpoints #110

Open
wslyvh opened this issue Feb 21, 2023 · 0 comments
Open

Improve naming of API endpoints #110

wslyvh opened this issue Feb 21, 2023 · 0 comments

Comments

@wslyvh
Copy link

wslyvh commented Feb 21, 2023

The current naming of the API endpoints seem confusing and don't really follow best practices.
Good API designs can improve the developer experience, making integrations more recognizable, faster and easier.

Since the development of the API still seems in early stages, it might be better to reconsider now before having to deal with backwards compatibility.

From what I understand the main resource here is registry which contains communities (or 'scores')
I'd suggest to use consistent naming. Scores and communities are somewhat confusing at the moment.

For the API, I'd propose the following..

Not sure if this is something that's supposed to be public, but I'd add
GET /registry - for an overview of all the registered communities.

Rename
GET /registry/signing-message -> GET /registry/nonce
POST /registry/submit-passport -> POST /registry/score/{community_id}

These remain the same
GET /registry/score/{community_id}
GET /registry/score/{community_id}/{address}

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