Merge pull request #1471 from wing328/invalid_array_type

Better error handling for invalid array/map type
2015-11-03 21:46:24 +08:00 · 2015-11-03 21:46:24 +08:00 · 1b538f6eaf
commit 1b538f6eaf
parent 5bf4d022cf c8ce84f650
26 changed files with 1674 additions and 729 deletions
--- a/modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java
+++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java
@ -814,6 +814,7 @@ public class DefaultCodegen {
            LOGGER.error("unexpected missing property for name " + name);
            return null;
        }
+
        CodegenProperty property = CodegenModelFactory.newInstance(CodegenModelType.PROPERTY);

        property.name = toVarName(name);
@ -1907,6 +1908,12 @@ public class DefaultCodegen {
        // character with _ or empty character. Below aims to spell out different cases we've
        // encountered so far and hopefully make it easier for others to add more special
        // cases in the future.
+    	
+    	// better error handling when map/array type is invalid
+    	if (name == null) {
+    	    LOGGER.error("String to be sanitized is null. Default to ERROR_UNKNOWN");
+    	    return "ERROR_UNKNOWN";
+    	}

        // input[] => input
        name = name.replaceAll("\\[\\]", "");
--- a/samples/client/petstore/java/default/pom.xml
+++ b/samples/client/petstore/java/default/pom.xml
@ -6,11 +6,7 @@
  <packaging>jar</packaging>
  <name>swagger-java-client</name>
  <version>1.0.0</version>
-  <scm>
-    <connection>scm:git:git@github.com:swagger-api/swagger-mustache.git</connection>
-    <developerConnection>scm:git:git@github.com:swagger-api/swagger-codegen.git</developerConnection>
-    <url>https://github.com/swagger-api/swagger-codegen</url>
-  </scm>
+
  <prerequisites>
    <maven>2.2.0</maven>
  </prerequisites>
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/ApiException.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/ApiException.java
@ -3,7 +3,7 @@ package io.swagger.client;
 import java.util.Map;
 import java.util.List;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class ApiException extends Exception {
  private int code = 0;
  private Map<String, List<String>> responseHeaders = null;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/Configuration.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/Configuration.java
@ -1,6 +1,6 @@
 package io.swagger.client;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class Configuration {
  private static ApiClient defaultApiClient = new ApiClient();

--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/JSON.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/JSON.java
@ -6,7 +6,7 @@ import com.fasterxml.jackson.datatype.joda.*;

 import java.io.IOException;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-21T11:55:29.717+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class JSON {
  private ObjectMapper mapper;

--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/Pair.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/Pair.java
@ -1,6 +1,6 @@
 package io.swagger.client;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class Pair {
    private String name = "";
    private String value = "";
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/StringUtil.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/StringUtil.java
@ -1,6 +1,6 @@
 package io.swagger.client;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class StringUtil {
  /**
   * Check if the given array contains the given value (with case-insensitive comparison).
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/TypeRef.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/TypeRef.java
@ -3,7 +3,7 @@ package io.swagger.client;
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class TypeRef<T> {
    private final Type type;

--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/api/PetApi.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/api/PetApi.java
@ -11,7 +11,7 @@ import java.io.File;

 import java.util.*;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-21T11:55:29.717+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class PetApi {
  private ApiClient apiClient;

--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/api/StoreApi.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/api/StoreApi.java
@ -11,7 +11,7 @@ import io.swagger.client.model.Order;

 import java.util.*;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-21T11:55:29.717+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class StoreApi {
  private ApiClient apiClient;

--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/api/UserApi.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/api/UserApi.java
@ -11,7 +11,7 @@ import java.util.*;

 import java.util.*;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-21T11:55:29.717+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class UserApi {
  private ApiClient apiClient;

--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/ApiKeyAuth.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/ApiKeyAuth.java
@ -5,7 +5,7 @@ import io.swagger.client.Pair;
 import java.util.Map;
 import java.util.List;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class ApiKeyAuth implements Authentication {
  private final String location;
  private final String paramName;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/Authentication.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/Authentication.java
@ -5,7 +5,7 @@ import io.swagger.client.Pair;
 import java.util.Map;
 import java.util.List;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public interface Authentication {
  /** Apply authentication settings to header and query params. */
  void applyToParams(List<Pair> queryParams, Map<String, String> headerParams);
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/HttpBasicAuth.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/HttpBasicAuth.java
@ -8,7 +8,7 @@ import java.util.List;
 import java.io.UnsupportedEncodingException;
 import javax.xml.bind.DatatypeConverter;

-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class HttpBasicAuth implements Authentication {
  private String username;
  private String password;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Category.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Category.java
@ -9,7 +9,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;


@ApiModel(description = "")
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class Category   {
  
  private Long id = null;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Order.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Order.java
@ -10,7 +10,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;


@ApiModel(description = "")
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class Order   {
  
  private Long id = null;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Pet.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Pet.java
@ -12,7 +12,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;


@ApiModel(description = "")
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class Pet   {
  
  private Long id = null;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Tag.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/Tag.java
@ -9,7 +9,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;


@ApiModel(description = "")
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class Tag   {
  
  private Long id = null;
--- a/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/User.java
+++ b/samples/client/petstore/java/default/src/main/java/io/swagger/client/model/User.java
@ -9,7 +9,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;


@ApiModel(description = "")
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T10:56:59.550-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
 public class User   {
  
  private Long id = null;
--- a/samples/dynamic-html/docs/assets/css/style.css
+++ b/samples/dynamic-html/docs/assets/css/style.css
@ -100,6 +100,10 @@
  float: left;
 }

+.param-enum {
+  margin-left: 20px;
+}
+
 .section-header {
  border-bottom: 2px;
  font-weight: bold;
--- a/samples/dynamic-html/docs/models/Category.html
+++ b/samples/dynamic-html/docs/models/Category.html
@ -3,13 +3,15 @@
  
 <ul class="parameter">
  <li class="param-required-">id : Long
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">name : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
--- a/samples/dynamic-html/docs/models/Order.html
+++ b/samples/dynamic-html/docs/models/Order.html
@ -3,37 +3,55 @@
  
 <ul class="parameter">
  <li class="param-required-">id : Long
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">petId : Long
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">quantity : Integer
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">shipDate : Date
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">status : String
-	  <br/>Order Status
+    <br/>Order Status
+    
+      <dl class="param-enum">
+        <dt>Enum:
+          
+            <dd>placed</dd>
+          
+            <dd>approved</dd>
+          
+            <dd>delivered</dd>
+          
+        </dt>
+      </dl>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">complete : Boolean
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
--- a/samples/dynamic-html/docs/models/Pet.html
+++ b/samples/dynamic-html/docs/models/Pet.html
@ -3,37 +3,55 @@
  
 <ul class="parameter">
  <li class="param-required-">id : Long
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">category : Category
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-true">name : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-true">photoUrls : List
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">tags : List
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">status : String
-	  <br/>pet status in the store
+    <br/>pet status in the store
+    
+      <dl class="param-enum">
+        <dt>Enum:
+          
+            <dd>available</dd>
+          
+            <dd>pending</dd>
+          
+            <dd>sold</dd>
+          
+        </dt>
+      </dl>
+    
  </li>
 </ul>
  
--- a/samples/dynamic-html/docs/models/Tag.html
+++ b/samples/dynamic-html/docs/models/Tag.html
@ -3,13 +3,15 @@
  
 <ul class="parameter">
  <li class="param-required-">id : Long
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">name : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
--- a/samples/dynamic-html/docs/models/User.html
+++ b/samples/dynamic-html/docs/models/User.html
@ -3,49 +3,57 @@
  
 <ul class="parameter">
  <li class="param-required-">id : Long
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">username : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">firstName : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">lastName : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">email : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">password : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">phone : String
-	  <br/>
+    <br/>
+    
  </li>
 </ul>
  
 <ul class="parameter">
  <li class="param-required-">userStatus : Integer
-	  <br/>User Status
+    <br/>User Status
+    
  </li>
 </ul>
  
--- a/samples/html/index.html
+++ b/samples/html/index.html