OpenAPITools/openapi-generator

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

Open

#5795 aperta il 2 apr 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Java (7516 fork)batch import
Client: ScalaEnhancement: FeatureHacktoberfesthelp wanted

Metriche repository

Star
 (26.243 star)
Metriche merge PR
 (Merge medio 12g 6h) (104 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
La richiesta riguarda l'aggiunta di documentazione generata automaticamente per il client scala akka. Fa riferimento a come è stato fatto nel client PowerShell, indicando file specifici in PowerShellExperimentalClientCodegen.java. Per implementarla, si dovrebbero seguire pattern simili: aggiungere riferimenti al percorso della documentazione e ai template in ScalaAkkaClientCodegen.java, creare template Mustache per la documentazione delle API e dei modelli, e personalizzare i nomi dei file di documentazione. I client Java e PowerShell esistenti servono come esempi.
Tech stack
javascala
Dominio
documentationbackend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
JavaScalaMustache templatesOpenAPI generator codebase
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30