OpenAPITools / OpenAPITools/openapi-generator

[REQ] Add Description to generators

Open
#3,219 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

When browsing the available generators and navigating to the detail page no description of the generator is given (or information on how to use it in your application).

Describe the solution you'd like

Add some information to these pages, especially:

  • some basic information on what is generated
  • Requirements that should be fulfilled to use the code generated
  • how it should be used in your application
  • how it can not be used and possible workarounds
  • +current bugs
  • (Maybe an example command to generate it, although that's covered by the general guide, but it makes life easier to just copy a command)

I am highly motivated to add this information to the generators listed below but would welcome a discussion about the structure or any other information missing.

Additional context

While looking for a generator for my new node-js backend I tried several generators, namely

  • typescript-node, which I could not get to work, because I was to lazy to find out which other packages I would need to install (this isn't mentioned anywhere)
  • typescript-rxjs, which does not work out-of-the-box with node-js
  • typescript-axios, which finally worked because the name already says what to install :)

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 with the available generators page and its linked generator detail pages, especially the TypeScript Node, TypeScript RxJS, and TypeScript Axios entries. Review the existing page structure and generator requirements before proposing a consistent documentation format. Done means the selected pages explain what they generate, required dependencies, known limitations or bugs, and an example command.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.