OpenAPITools/openapi-generator

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

Open

#5 795 ouverte le 2 avr. 2020

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
javascala
Domaine
documentationbackend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
JavaScalaMustache templatesOpenAPI generator codebase
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30
Direction de recherche
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.