OpenAPITools / OpenAPITools/openapi-generator
[REQ] Explanation on NotFoundException purpose
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
In the context of JaxRS server generation (resteasy here, but I think it applies to many other), we get each API endpoint declaration throwing a NotFoundException. However there is no clear explanation on what is its purpose, given the fact that if you manage to get to the endpoint, you obviously find it.
Describe the solution you'd like
Adding some Javadoc maybe to the Mustache template?
Describe alternatives you've considered
Not sure if it can just be simply removed, but I'm probably missing the big picture.
Additional context
Well, IntelliJ always complains about this exception not used :)
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
Inspect the JAX-RS server-generation Mustache template and the generated NotFoundException declarations, starting with the endpoint code described in the issue. Confirm why the exception is present and document that purpose in the relevant template or documentation; done means the generated code's behavior is clearly explained and the IntelliJ warning concern is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100