Skip to content

fix(config): add openapiGeneratorIgnoreList to the config schema - #1292

Merged
wing328 merged 2 commits into
OpenAPITools:masterfrom
Inf1mum:fix/1138-openapi-generator-ignore-list-schema
Nov 9, 2026
Merged

wing328 merged 2 commits into
OpenAPITools:masterfrom
Inf1mum:fix/1138-openapi-generator-ignore-list-schema

Conversation

@Inf1mum

@Inf1mum Inf1mum commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #1138

As requested by @wing328 in the issue thread, this PR adds the missing openapiGeneratorIgnoreList option to apps/generator-cli/src/config.schema.json.

What was done

  • Added openapiGeneratorIgnoreList to the generator definition in the config schema. Configs using the option (as the reporter does) no longer fail schema validation in editors.
  • The property accepts an array of strings — the shape the reporter uses and the type upstream openapi-generator uses for this option (Set<String> in GeneratorSettings/CodegenConfigurator). A comma separated list is accepted as well, mirroring the --openapi-generator-ignore-list CLI flag.
  • Added ajv-based tests in apps/generator-cli/src/config.schema.spec.ts that validate the schema itself and configs using the new option (arrays, comma separated lists, and invalid values).

Validation

  • nx test generator-cli: 7 suites, 247 tests passed (12 of them the new schema tests)
  • nx lint generator-cli: passes

Summary by cubic

Adds the missing openapiGeneratorIgnoreList option to the generator CLI config schema and fixes how the CLI serializes array config values.

  • The property accepts an array of strings or a comma-separated list, mirroring the --openapi-generator-ignore-list CLI flag, so configs using it no longer fail schema validation in editors.
  • buildCommand now joins array values with commas instead of rendering them as indexed entries, so the option never reached the generator as the intended list.
  • Adds ajv-based schema tests and generator command tests for the option's accepted and rejected values.

Written for commit 1fc35a7. Summary will update on new commits.

View guided diff

The runtime option openapiGeneratorIgnoreList works but was missing from
apps/generator-cli/src/config.schema.json, so editors flag configs using
it as invalid (Fixes OpenAPITools#1138).

The option is typed as Set<String> upstream in openapi-generator's
GeneratorSettings/CodegenConfigurator and pre-populates the
.openapi-generator-ignore file, so the new property accepts an array of
strings; a comma separated list is accepted as well, mirroring the
--openapi-generator-ignore-list CLI flag.

Adds ajv-based tests validating the schema itself and configs using the
new option.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 4 files

Reply with feedback, questions, or to request a fix.

View guided diff | Re-trigger cubic

buildCommand rendered array values through Object.entries, producing
indexed assignments such as 0=README.md,1=pom.xml, so array configs like
openapiGeneratorIgnoreList never reached the generator as the intended
list. Array values are now joined with ',', matching the csv semantics
of flags such as --openapi-generator-ignore-list; string and plain
object values keep their existing serialization.
@wing328
wing328 merged commit db7d393 into OpenAPITools:master Nov 9, 2026
4 checks passed
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown

🎉 This PR is included in version 2.42.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] openapiGeneratorIgnoreList is missing from schema

2 participants