OpenAPITools / OpenAPITools/openapi-generator
[REQ] Add auto-generated doc to scala-akka client
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.
-
Add auto-generated doc (API, Model) to scala-akka client similar to what've done in other clients.
-
improve the README (example)
Additional context
-
Customize the doc file name (https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PowerShellExperimentalClientCodegen.java#L613, https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PowerShellExperimentalClientCodegen.java#L628)
-
Provide the doc templates, e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/Java/api_doc.mustache, https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/Java/model_doc.mustache
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 the scala-akka client sample README and compare it with the linked PowerShellExperimentalClientCodegen.java documentation path, template, and filename customization examples. Review the linked Java api_doc.mustache and model_doc.mustache templates. Done means the scala-akka client generates API and model documentation and its README is improved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, scala
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100