OpenAPITools / OpenAPITools/openapi-generator

[REQ] Convert `debug` global properties to separate output options

Open
#18,880 0 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.

Cannot currently output debugging information as described in https://openapi-generator.tech/docs/debugging#templates separate from logs without also changing the logging configuration since the output stream is mixed, by default.

Describe the solution you'd like

Instead of running a command like:

openapi-generator generate -g go \
    -o out \
    -i petstore-minimal.yaml \
    --global-property debugModels,debugOperations

I should be able to run:

# also support debugSupportingFiles and debugOpenAPI the same way
openapi-generator generate -g go \
    -o out \
    -i petstore-minimal.yaml \
    --debug-models-out debug/models.json \
    --debug-operations-out debug/operations.json

Describe alternatives you've considered

None

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 tracing how the CLI handles --global-property debugModels and debugOperations, using the debugging documentation and the command examples in this issue. Determine where output streams are selected; done means separate options also support debugSupportingFiles and debugOpenAPI while leaving logging configuration independent.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.