OpenAPITools / OpenAPITools/openapi-generator

[REQ] [Documentation] Customization Docs need a huge upgrade

Open
#21,694 2 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.

It took ages to start understanding how the generator worked and there was basically no documentation so I was entering class after class to read and try to understand the codebase to customize the generator. There are also a lot of basic things that i didn t know about beforehand because they are just present as 1 line in a class and no doc is there for them.

Describe the solution you'd like

I think a general Customization doc for Generators/Codegens would be very helpfull. It should contain the order of opperation of the functions you can override, OpenAPIpreprocessing -> ModelGeneration -> APIGeneration, etc... maybe a bit more in detail. It should also contain the Normalizer Rules and what to add and etc... because these are not mentioned anywhere i read. there's a big need for clarity in general

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

No files or tests are identified in the issue. Start by tracing the customization flow from OpenAPI preprocessing through model generation and API generation, then review the normalizer rules. Done means a clear customization guide documents the operation order, override points, and normalizer guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation, tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.