OpenAPITools/openapi-generator

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

Open

#5,795 opened on Apr 2, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (26,243 stars) (7,516 forks)batch import
Client: ScalaEnhancement: FeatureHacktoberfesthelp wanted

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

Contributor guide

Tech stack
javascala
Domain
documentationbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScalaMustache templatesOpenAPI generator codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
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.