OpenAPITools/openapi-generator

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

Open

#8.426 aberto em 13 de jan. de 2021

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees)Java (7.516 forks)batch import
Client: CEnhancement: FeatureHacktoberfesthelp wanted

Métricas do repositório

Stars
 (26.243 stars)
Métricas de merge de PR
 (Mesclagem média 12d 6h) (104 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Examine o modelo de documentação do cliente Ruby em samples/client/petstore/ruby/docs/PetApi.md e os modelos de documentação do gerador C++. Localize os arquivos de modelo do cliente C em modules/openapi generator/src/main/resources/c/. Defina novos arquivos de modelo Mustache para gerar documentação em Markdown semelhante aos exemplos Ruby e C++.
Pilha de tecnologia
c
Domain
documentationapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with Mustache templatesOpenAPI Generator codebase structure
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60