OpenAPITools / OpenAPITools/openapi-generator

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

Open
#8,426 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: C Enhancement: Feature Hacktoberfest help wanted
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the referenced samples/client/petstore/ruby/docs/PetApi.md with the documentation output from the C++ generators, then locate the C client generator templates. The work is done when C client generation automatically includes equivalent API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.