OpenAPITools/openapi-generator

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

Open

#5.795 geöffnet am 2. Apr. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (26.243 Stars) (7.516 Forks)batch import
Client: ScalaEnhancement: FeatureHacktoberfesthelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
JavaScalaMustache templatesOpenAPI generator codebase
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30
Research-Richtung
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.