Alteration to various end points to take the office id as a query parameter
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
While talking @ktarbet through how some of the API works I think I've stumbled upon a better way to handle the office-id for the objects.
currently for, say locations, we have
/locations/Alder Springs?office-id=SPK to retrieve the information for one location.
it seems like it would be better if we had
/location/SPK/Alder Springs to retrieve information for one location
and perhaps
/locations/SPK to retrieve all locations for SPK. Currently we have the catalog but that was really more because I couldn't think of a better away at the time with the existing functionality in the database but since that's going away eventually this would be a good replacement.
All the other parameters would be the same.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing location endpoints described in issue 414, including the catalog behavior and current office-id query parameter. Inventory the other affected endpoints before deciding the scope. Done means the agreed office-id path structure is applied consistently and the existing parameters and retrieval behavior remain covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100