OpenAPITools / OpenAPITools/openapi-generator

[REQ] Batch should support --dry-run

Open
#17,084 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.

batch does not seem to support --dry-run in neither the command line arguments nor the configuration files. I would like to see what would potentially be outputted by all that is to be generated.

Describe the solution you'd like

I think batch should have a --dry-run flag just like generate. The config files do not seem to support a dryRun yaml field, but im not sure it makes sense to include that anyways. If at all, it would mark the configuration as only running a dry run.

Both could be implemented, but I think it makes the most sense to include a --dry-run cli flag to see how the whole batch might turn out.

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 locating the CLI implementation for batch and compare how the generate command handles --dry-run. Verify the expected behavior for batch execution and whether configuration-file support is in scope. Done means batch --dry-run previews all generation results without writing them, with tests covering the command behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.