OpenAPITools / OpenAPITools/openapi-generator
[REQ] Add possibility to change exception javadoc text
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 our current project we are required to generate various Javadoc comments in German. This includes of course the documentation of the api-client.
In the current implementation (generatorName=java, library=native) the text is fixed.
* @throws ApiException if fails to make API call.
Is there any way to customize this?
Translated with www.DeepL.com/Translator (free version)
Describe the solution you'd like
Describe alternatives you've considered
Additional context
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 with modules/openapi-generator/src/main/resources/Java/libraries/native/api.mustache and inspect how the Java native generator handles configurable template text. Determine the existing customization entry points, if any, and define how the exception Javadoc wording should be supplied. Done means generated API clients can use a customized @throws ApiException description for this generator and library.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100