Greenstand / Greenstand/treetracker-admin-api

Make API endpoint naming more consistent

Open
#481 1 comment 0 reactions 0 assignees View on GitHub
ice box wontfix
Dominant language
TypeScript
Stars
32
Forks
85
PR merge metrics
No merged PRs in 30d

Description

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`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.