From 6cdba23ec22957a8482ebf3b179eaa8348fbf89d Mon Sep 17 00:00:00 2001 From: Hugo Mercado Date: Fri, 26 Jul 2019 06:48:24 -0500 Subject: [PATCH] added option to disable examples. --- .../java/io/swagger/codegen/v3/cli/cmd/Generate.java | 9 +++++++++ modules/swagger-codegen-cli/src/main/resources/oas3.yaml | 7 ++++++- .../java/io/swagger/codegen/v3/CodegenConstants.java | 1 + 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/modules/swagger-codegen-cli/src/main/java/io/swagger/codegen/v3/cli/cmd/Generate.java b/modules/swagger-codegen-cli/src/main/java/io/swagger/codegen/v3/cli/cmd/Generate.java index 2727924335d..3c85aef247a 100644 --- a/modules/swagger-codegen-cli/src/main/java/io/swagger/codegen/v3/cli/cmd/Generate.java +++ b/modules/swagger-codegen-cli/src/main/java/io/swagger/codegen/v3/cli/cmd/Generate.java @@ -74,6 +74,7 @@ public class Generate implements Runnable { protected List reservedWordsMappings = new ArrayList<>(); protected String ignoreFileOverride; protected Boolean removeOperationIdPrefix; + protected Boolean disableExamples; private String url; private List codegenArguments; @@ -213,6 +214,10 @@ public void setCodegenArguments(List codegenArguments) { this.codegenArguments = codegenArguments; } + public void setDisableExamples(Boolean disableExamples) { + this.disableExamples = disableExamples; + } + @Override public void run() { @@ -324,6 +329,10 @@ public void run() { configurator.setCodegenArguments(codegenArguments); } + if (disableExamples != null && disableExamples) { + additionalProperties.add(String.format("%s=%s", CodegenConstants.DISABLE_EXAMPLES_OPTION, disableExamples.toString())); + } + if (CodegenConstants.MUSTACHE_TEMPLATE_ENGINE.equalsIgnoreCase(templateEngine)) { additionalProperties.add(String.format("%s=%s", CodegenConstants.TEMPLATE_ENGINE, CodegenConstants.MUSTACHE_TEMPLATE_ENGINE)); } else { diff --git a/modules/swagger-codegen-cli/src/main/resources/oas3.yaml b/modules/swagger-codegen-cli/src/main/resources/oas3.yaml index aab26307736..2bebbe61a0a 100644 --- a/modules/swagger-codegen-cli/src/main/resources/oas3.yaml +++ b/modules/swagger-codegen-cli/src/main/resources/oas3.yaml @@ -196,6 +196,11 @@ components: description: "load arguments from a local file or remote URL. Arguments found will replace any one placed on command." x-option: "--url" x-short-version: "-u" + disableExamples: + type: "boolean" + title: "disable examples" + description: "avoid writing json/xml examples on generated operations." + x-option: "--disable-examples" ConfigHelp: x-command: "config-help" x-command-description: "Config help for chosen lang" @@ -236,4 +241,4 @@ components: x-class-name: "io.swagger.codegen.v3.cli.cmd.Langs" Version: x-command-description: "Show version information" - x-class-name: "io.swagger.codegen.v3.cli.cmd.Version" \ No newline at end of file + x-class-name: "io.swagger.codegen.v3.cli.cmd.Version" diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/CodegenConstants.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/CodegenConstants.java index 247ff89d9cc..85ead4c8d6a 100644 --- a/modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/CodegenConstants.java +++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/CodegenConstants.java @@ -235,6 +235,7 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case, public static final String USE_OAS2_DESC = "use OpenAPI v2.0 (Swagger 1.5.x)"; public static final String TEMPLATE_ENGINE = "templateEngine"; + public static final String DISABLE_EXAMPLES_OPTION = "disableExample"; public static final String IS_ENUM_EXT_NAME = PREFIX_IS + "enum"; public static final String IS_ALIAS_EXT_NAME = PREFIX_IS + "alias";