Add a new parameters to ignore headers starting with "X-" because mos…

…t of the time, they are "standard" and must follow other convention. (#4)
OpenAPITools · Jul 18, 2018 · ea18d42 · ea18d42
1 parent e8ecda5
commit ea18d42
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 21 deletions.
diff --git a/.idea/modules/modules/cli/modules_cli.iml b/.idea/modules/modules/cli/modules_cli.iml
diff --git a/.idea/modules/modules/cli/modules_cli_main.iml b/.idea/modules/modules/cli/modules_cli_main.iml
diff --git a/.idea/modules/modules/cli/modules_cli_test.iml b/.idea/modules/modules/cli/modules_cli_test.iml
diff --git a/.idea/modules/modules/lib/modules_lib.iml b/.idea/modules/modules/lib/modules_lib.iml
diff --git a/.idea/modules/modules/lib/modules_lib_main.iml b/.idea/modules/modules/lib/modules_lib_main.iml
diff --git a/.idea/modules/modules/lib/modules_lib_test.iml b/.idea/modules/modules/lib/modules_lib_test.iml
diff --git a/build.gradle b/build.gradle
@@ -1,7 +1,7 @@
 subprojects {
 apply plugin: "java"
 
-  version = '1.0'
+  version = '1.1'
 
   repositories {
     mavenCentral()

diff --git a/modules/lib/src/main/java/com/jaffsoft/openapistylevalidator/OpenApiSpecStyleValidator.java b/modules/lib/src/main/java/com/jaffsoft/openapistylevalidator/OpenApiSpecStyleValidator.java
@@ -146,13 +146,22 @@ private void validateNaming() {
                 for (HttpMethod method : path.getOperationMap().keySet()) {
                     Operation op = path.getOperationMap().get(method);
                     for (Parameter opParam : op.getParameters()) {
-                        boolean isValid = namingValidator.isNamingValid(opParam.getName(), parameters.getParameterNamingStrategy());
-                        if (!isValid) {
-                            errorAggregator.logOperationBadNaming(opParam.getName(),
-                                    "parameter",
-                                    parameters.getParameterNamingStrategy().getAppelation(),
-                                    key,
-                                    method);
+                        boolean shouldValidate;
+                        if (opParam.getIn().equals("header") && opParam.getName().startsWith("X-")) {
+                            shouldValidate = !parameters.isIgnoreHeaderXNaming();
+                        } else {
+                            shouldValidate = true;
+                        }
+
+                        if (shouldValidate) {
+                            boolean isValid = namingValidator.isNamingValid(opParam.getName(), parameters.getParameterNamingStrategy());
+                            if (!isValid) {
+                                errorAggregator.logOperationBadNaming(opParam.getName(),
+                                        "parameter",
+                                        parameters.getParameterNamingStrategy().getAppelation(),
+                                        key,
+                                        method);
+                            }
                         }
                     }
                 }

diff --git a/modules/lib/src/main/java/com/jaffsoft/openapistylevalidator/ValidatorParameters.java b/modules/lib/src/main/java/com/jaffsoft/openapistylevalidator/ValidatorParameters.java
@@ -31,6 +31,7 @@ public String getAppelation() {
     private boolean validateModelNoLocalDef = true;
 
     private boolean validateNaming = true;
+    private boolean ignoreHeaderXNaming = true;
     private NamingStrategy pathNamingStrategy = NamingStrategy.HyphenCase;
     private NamingStrategy parameterNamingStrategy = NamingStrategy.CamelCase;
     private NamingStrategy propertyNamingStrategy = NamingStrategy.CamelCase;
@@ -142,4 +143,12 @@ boolean isValidateNaming() {
     void setValidateNaming(boolean validateNaming) {
         this.validateNaming = validateNaming;
     }
+
+    boolean isIgnoreHeaderXNaming() {
+        return ignoreHeaderXNaming;
+    }
+
+    void setIgnoreHeaderXNaming(boolean ignoreHeaderXNaming) {
+        this.ignoreHeaderXNaming = ignoreHeaderXNaming;
+    }
 }
diff --git a/modules/lib/src/test/java/com/jaffsoft/openapistylevalidator/ValidatorParametersTest.java b/modules/lib/src/test/java/com/jaffsoft/openapistylevalidator/ValidatorParametersTest.java
@@ -27,6 +27,7 @@ public void validateDefaultValues() {
         assertTrue(parameters.isValidateModelNoLocalDef());
 
         assertTrue(parameters.isValidateNaming());
+        assertTrue(parameters.isIgnoreHeaderXNaming());
         assertEquals(ValidatorParameters.NamingStrategy.HyphenCase, parameters.getPathNamingStrategy());
         assertEquals(ValidatorParameters.NamingStrategy.CamelCase, parameters.getParameterNamingStrategy());
         assertEquals(ValidatorParameters.NamingStrategy.CamelCase, parameters.getPropertyNamingStrategy());
@@ -44,6 +45,7 @@ public void testAllGetterSetters() {
         parameters.setValidateModelPropertiesExample(false);
         parameters.setValidateModelNoLocalDef(false);
         parameters.setValidateNaming(false);
+        parameters.setIgnoreHeaderXNaming(false);
 
         parameters.setPathNamingStrategy(ValidatorParameters.NamingStrategy.CamelCase);
         parameters.setParameterNamingStrategy(ValidatorParameters.NamingStrategy.CamelCase);
@@ -59,6 +61,7 @@ public void testAllGetterSetters() {
         assertFalse(parameters.isValidateModelPropertiesExample());
         assertFalse(parameters.isValidateModelNoLocalDef());
         assertFalse(parameters.isValidateNaming());
+        assertFalse(parameters.isIgnoreHeaderXNaming());
 
         assertEquals(ValidatorParameters.NamingStrategy.CamelCase, parameters.getPathNamingStrategy());
         assertEquals(ValidatorParameters.NamingStrategy.CamelCase, parameters.getParameterNamingStrategy());

diff --git a/specs/options.json b/specs/options.json
@@ -12,6 +12,7 @@
   "validateModelNoLocalDef": true,
 
   "validateNaming": true,
+  "ignoreHeaderXNaming": true,
   "pathNamingStrategy": "HyphenCase",
   "parameterNamingStrategy": "CamelCase",
   "propertiesNamingStrategy": "CamelCase"