OpenAPITools/openapi-generator

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

Open

#5,795 opened on 2020年4月2日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Java (26,243 stars) (7,516 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.