OpenAPITools/openapi-generator

[REQ] [C][Client] Generate document automatically for C client

Open

#8.426 geöffnet am 13. Jan. 2021

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

Beschreibung

Describe the solution you'd like

I'd like to add the templates to auto-generate documentation for C client Just like ruby client https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/ruby/docs/PetApi.md and C++ generators do.

Contributor Guide

Tech Stack
c
Domain
documentationapi
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-3 hours
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.
clear
Voraussetzungen
Familiarity with Mustache templatesOpenAPI Generator codebase structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Examine the Ruby client documentation template at samples/client/petstore/ruby/docs/PetApi.md and the C++ generator's documentation templates. Locate the C client template files under modules/openapi generator/src/main/resources/c/. Define new Mustache template files for generating Markdown documentation similar to the Ruby and C++ examples.