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.
[REQ] Add auto-generated doc to scala-akka client · OpenAPITools/openapi-generator#5795 | Good First Issue