Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[BUG] Inconsistent openapitools.json handling beetwen npm and docker version of openapi-generator-cli

Abierto
#664 1 comentario 7 reacciones 1 asignado Ver en GitHub

@kay-schecker ya está trabajando en esto.

Desde el 16/9/2022.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

bug

🐛 Bug Report:

Describe the bug

I want to configure generation in CLI in some kind of config file. When using (npm) generator-cli readme says that you can configure it with openapitools.json file and later use openapi-generator-cli generate --generator-key YOUR_GENERATOR_KEY but on the other hand if you want to use (docker) generator-cli this kind of configuration is unexpected.

Steps to Reproduce

Given such a config (config/config.json) file:

{
  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
  "spaces": 2,
  "generator-cli": {
    "version": "6.1.0",
    "generators": {
      "v3.0": {
        "generatorName": "spring",
        "output": "/local",
        "inputSpec": "https://raw.githubusercontent.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml",
        "globalProperty": {
          "models": "Order,User",
        },
        "additionalProperties": {
          "apiPackage": "com.test",
          "modelPackage": "com.test.model",
          "supportingFilesToGenerate": "ApiUtil.java",
          "groupId": "com.test",
          "artifactId": "test",
          "artifactVersion": "0.0.0",
          "interfaceOnly": true
        }
      }
    }
  }
}

Command:

docker run --rm -v "${PWD}/tmp:/local" -v "${PWD}/config/config.json:/openapitools.json" openapitools/openapi-generator-cli:v6.1.0 generate --generator-key v3.0

Produces:

[error] Found unexpected parameters: [--generator-key, v3.0]

See 'openapi-generator-cli help' for usage.
Expected behavior

Consistent behavior for both npm generator-cli and docker generator-cli.

Operation System:
  • OS: Windows
  • Version 10
Package System:

No package system, just docker:

  • Docker version 20.10.17, build 100c701
Additional context

IMO it should be well documented (and consistent) how to configure all of configuration properties (global and additional) by CLI using some kind of config file for both npm and docker CLI as it is helpful in CI/CD tools.

Lenguaje dominante
TypeScript
Estrellas
2k
Forks
208
Merge medio
7 h 12 min
PR fusionados (30 d)
6

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenAPITools/openapi-generator-cli

Todos los issues de OpenAPITools/openapi-generator-cli

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.