Update Controller endpoints to have a base class
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
Let's update the Controller endpoints to include a base class that contains common utility methods and fields similar to the BaseOutletHandler referenced here.
If we do a base class agnostic of the Handler and CrudHandler interface, that's 51 classes that'll need an update. I'm down for doing that in a separate PR, but where does that time go? We can always create a ticket, and put that on hold until we can decide on that?
Originally posted by @RyanM-RMA in https://github.com/USACE/cwms-data-api/pull/764#discussion_r1687189210
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 locating the Controller endpoint classes and comparing their shared needs with BaseOutletHandler, the only referenced implementation. Inventory the 51 affected classes and resolve whether the base class must remain independent of the Handler and CrudHandler interfaces; done means the scope and design are agreed before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100