Review controller parameters and determine if those marked required are required.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
If the parameters are actually required we should throw an exception if they are missing. Controllers has examples of one way to do that.
If they aren't required removed the required swagger annotation.
If they are required in v1 and optional in v2 we should document that.
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
Review the controller parameter declarations and the existing Controllers examples for how missing required parameters are handled. Determine which parameters marked required are truly mandatory, then verify the v1 and v2 behavior before deciding whether to add exceptions, remove Swagger annotations, or document version differences. Done means every reviewed parameter has behavior and documentation consistent with its actual requirement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100