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

Make API endpoint naming more consistent #481

Open
nmcharlton opened this issue Dec 13, 2020 · 1 comment
Open

Make API endpoint naming more consistent #481

nmcharlton opened this issue Dec 13, 2020 · 1 comment
Labels
ice box Issues to be considered later wontfix This will not be worked on

Comments

@nmcharlton
Copy link
Collaborator

There is some variation in the syntax of the Admin Panel internal REST API.
Endpoints mix singular and plural nouns for collections, as well as hyphens and underscores for multi-word endpoints.
https://restfulapi.net/resource-naming/ provides some good guidance for best practice.

Below are the endpoints that need to be updated (at the time of writing).

Current New
/api/planter /api/planters
/api/tree_tags /api/tree-tags
/api/planter-registration /api/planter-registrations
/api/organization /api/organizations
/api/organization/{id}/planter /api/organizations/{id}/planters
/auth/admin_users /auth/admin-users
/auth/check_session /auth/check-session
@nmcharlton nmcharlton added the good first issue Good for newcomers label Dec 13, 2020
@nmcharlton nmcharlton removed the good first issue Good for newcomers label Feb 1, 2021
@nmcharlton
Copy link
Collaborator Author

We're in the process of moving to a new set of API microservices that will eventually replace much of the existing Admin Panel API, so this standardisation is of low priority.

@nmcharlton nmcharlton added the ice box Issues to be considered later label Feb 14, 2021
@nmcharlton nmcharlton added the wontfix This will not be worked on label Jul 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ice box Issues to be considered later wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant