OpenAPITools/openapi-generator

[REQ] Add auto-generated doc to scala-akka client

Open

#5,795 创建于 2020年4月2日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Java (26,243 star) (7,516 fork)batch import
Client: ScalaEnhancement: FeatureHacktoberfesthelp wanted

描述

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

贡献者指南

技术栈
javascala
领域
documentationbackend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
JavaScalaMustache templatesOpenAPI generator codebase
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30
研究方向
The issue requests adding auto generated documentation for the scala akka client. It references how it was done in the PowerShell client, pointing to specific files in PowerShellExperimentalClientCodegen.java. To implement, one should follow similar patterns: add doc path and template references in the ScalaAkkaClientCodegen.java, create Mustache templates for API and model docs, and customize doc file names. The existing Java and PowerShell clients serve as examples.