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 (7,516 forks)batch import
Client: ScalaEnhancement: FeatureHacktoberfesthelp wanted

Repository metrics

Stars
 (26,243 stars)
PR merge metrics
 (Avg merge 9d 1h) (123 merged PRs in 30d)

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

Research direction
Study the existing documentation generation in PowerShell or Java clients, then replicate the pattern in the Scala/Akka codegen class, adding the doc templates and updating the README.
Tech stack
javascala
Domain
backendapidocumentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaGitScala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70