OpenAPITools / OpenAPITools/openapi-generator
[REQ] Specify which examples to add to HTML2 documentation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Describe the solution you'd like
I only generate about 7 client libraries for my API and it would be great if I could specify to generate examples (in HTML2 documentation) for the client libraries I am making available. The HTML2 docs are great but some of the samples are irrelevant to my project as I'm not supplying those particular client libraries.
e.g. the tabs showing examples can't be controlled yet.
It would be great if I could list the code examples I want either in the command or config file (e.g. -examples csharp php javascript) and only those code examples will show in the tabs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the HTML2 documentation generator and the command or configuration entry point for selecting client libraries. Trace how the example tabs are assembled; done means an option limits the tabs to the requested libraries, with coverage for both command-line and configuration use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100